org.okiproject.serviceapi.logging
Interface Formatter

All Superinterfaces:
java.io.Serializable

public interface Formatter
extends java.io.Serializable

Purpose: Represents the formatting strategy used for the message.

Copyright (c) 2001 Massachusetts Institute of Technology

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

$Source: /cvs/oki/org/okiproject/serviceapi/doc/logging/org/okiproject/serviceapi/logging/Formatter.html,v $


Method Summary
 java.lang.String format(org.okiproject.serviceapi.common.Agent who, java.lang.String message)
          Formats input String in format specified
 

Method Detail

format

public java.lang.String format(org.okiproject.serviceapi.common.Agent who,
                               java.lang.String message)
Formats input String in format specified
Parameters:
who - Represents the Agent state for authn/authz purposes.
message - Input message, possibly with formatting directives.
Returns:
Formatted string.