Package com.iplanet.services.comm.server

Class PLLAuditor

java.lang.Object

com.iplanet.services.comm.server.PLLAuditor

public class PLLAuditor
extends Object

Responsible for publishing audit access events for individual PLL request.

Field Summary

Fields

Modifier and Type	Field	Description
static String	PLL

Constructor Summary

Constructors

Constructor	Description
PLLAuditor(Debug debug, AuditEventPublisher auditEventPublisher, AuditEventFactory auditEventFactory, jakarta.servlet.http.HttpServletRequest httpServletRequest)	Create a new Auditor.

Method Summary

Modifier and Type	Method	Description
void	auditAccessAttempt()	Publishes an audit event with details of the attempted CREST operation, if the 'access' topic is audited.
void	auditAccessFailure(String message)	Publishes an event with details of the failed CREST operation, if the 'access' topic is audited.
void	auditAccessFailure(String errorCode, String message)	Publishes an event with details of the failed CREST operation, if the 'access' topic is audited.
void	auditAccessSuccess()	Publishes an event with details of the successfully completed CREST operation, if the 'access' topic is audited.
void	setComponent(AuditConstants.Component component)
void	setMethod(String method)
void	setRealm(String realm)
void	setSsoToken(SSOToken ssoToken)	Provide SSOToken of originating client in order to lookup session trackingId and realm.
void	setTrackingId(String trackingId)
void	setUserId(String userId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PLL

public static final String PLL

See Also:

Constant Field Values

Constructor Detail

PLLAuditor

public PLLAuditor(Debug debug,
                  AuditEventPublisher auditEventPublisher,
                  AuditEventFactory auditEventFactory,
                  jakarta.servlet.http.HttpServletRequest httpServletRequest)

Create a new Auditor.

Parameters:

debug - Debug instance.

auditEventPublisher - AuditEventPublisher to which publishing of events can be delegated.

auditEventFactory - AuditEventFactory for audit event builders.

httpServletRequest -

Method Detail

auditAccessAttempt

public void auditAccessAttempt()

Publishes an audit event with details of the attempted CREST operation, if the 'access' topic is audited.

Throws:

org.forgerock.audit.AuditException - If an exception occurred that prevented the audit event from being published.

auditAccessSuccess

public void auditAccessSuccess()

Publishes an event with details of the successfully completed CREST operation, if the 'access' topic is audited.

Any exception that occurs while trying to publish the audit event will be captured in the debug logs but otherwise ignored.

auditAccessFailure

public void auditAccessFailure(String message)

Publishes an event with details of the failed CREST operation, if the 'access' topic is audited.

Any exception that occurs while trying to publish the audit event will be captured in the debug logs but otherwise ignored.

Parameters:

message - A human-readable description of the error that occurred.

auditAccessFailure

public void auditAccessFailure(String errorCode,
                               String message)

Publishes an event with details of the failed CREST operation, if the 'access' topic is audited.

Any exception that occurs while trying to publish the audit event will be captured in the debug logs but otherwise ignored.

Parameters:

errorCode - A unique code that identifies the error condition.

message - A human-readable description of the error that occurred.

setComponent

public void setComponent(AuditConstants.Component component)

Parameters:

component - Identifies the functional area of OpenAM with which this PLL service interacts.

setMethod

public void setMethod(String method)

Parameters:

method - Identifies the RequestHandler operation invoked.

setSsoToken

public void setSsoToken(SSOToken ssoToken)

Provide SSOToken of originating client in order to lookup session trackingId and realm. If the current server is not the 'home server' for the session, obtaining an SSOToken can itself lead to PLL communication between servers; therefore, it's worth considering whether or not this method should be used on a case-by-case basis. When obtaining an SSOToken may not be appropriate, the setDomain and setTrackingId methods may be useful alternatives if this information is available via other means.

Parameters:

ssoToken - SSOToken of the originating client from which the session trackingId and realm are obtained.

setTrackingId

public void setTrackingId(String trackingId)

Parameters:

trackingId - Unique alias of session.

setUserId

public void setUserId(String userId)

Parameters:

userId - Identifies Subject of authentication.

setRealm

public void setRealm(String realm)

Parameters:

realm - The realm for which the event is being logged.