org.okiproject.serviceapi.logging
Interface LogService

All Superinterfaces:
java.io.Serializable

public interface LogService
extends java.io.Serializable

Purpose: Represents the logging service abstraction. This will typically be a singleton per JVM.

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/LogService.html,v $


Method Summary
 void chainLogger(org.okiproject.serviceapi.common.Agent who, Logger logger)
          Add a logger to the chain.
 Priority getBasePriority(org.okiproject.serviceapi.common.Agent who)
          Gets the threshold priority for the logging service.
 void setBasePriority(org.okiproject.serviceapi.common.Agent who, Priority priority)
          Sets the threshold priority for the logging service.
 void unchainLogger(org.okiproject.serviceapi.common.Agent who, Logger logger)
          Removes a logger from the chain.
 

Method Detail

chainLogger

public void chainLogger(org.okiproject.serviceapi.common.Agent who,
                        Logger logger)
                 throws LogServiceException
Add a logger to the chain. Each logger serves as a kind of handler for logging events.
Parameters:
who - Represents the Agent state for authn/authz purposes.
logger - Represents the specific logging event handler.
Throws:
LogServiceException - if some error occurs while chaining this handler.

unchainLogger

public void unchainLogger(org.okiproject.serviceapi.common.Agent who,
                          Logger logger)
                   throws LogServiceException
Removes a logger from the chain.
Parameters:
who - Represents the Agent state for authn/authz purposes.
logger - Represents the specific logging event handler.
Throws:
LogServiceException - if some error occurs while unchainig this handler.

setBasePriority

public void setBasePriority(org.okiproject.serviceapi.common.Agent who,
                            Priority priority)
Sets the threshold priority for the logging service. Messages at a priority lower than this level will be ignored.
Parameters:
who - Represents the Agent state for authn/authz purposes.
priority - Represents the system logging priority.

getBasePriority

public Priority getBasePriority(org.okiproject.serviceapi.common.Agent who)
Gets the threshold priority for the logging service.
Parameters:
who - Represents the Agent state for authn/authz purposes.