edu.internet2.middleware.shibboleth.common.log
Class AuditLogEntry

java.lang.Object
  extended by edu.internet2.middleware.shibboleth.common.log.AuditLogEntry

public class AuditLogEntry
extends Object

Represents an auditable event in the system.


Field Summary
private  String assertingPartyId
          Entity ID of the provider (message issuer).
static String AUDIT_LOGGER_NAME
          Name of the Logger for the shibboleth audit log.
private  org.joda.time.DateTime auditEventTime
          UTC IS8601 timestamp of the audit event.
private static org.joda.time.format.DateTimeFormatter dateFormatter
          Formatter used to convert timestamps to strings.
private  String messageProfile
          URI of profile in use.
private  String nameIdValue
          Value of the SAML name identifier.
private  String principalAuthenticationMethod
          URIs of the authentication methods currently active for the user.
private  String principalName
          Principal ID of the user the request was made about.
private  List<String> releasedAttributes
          Internal ID of the user attributes released.
private  String relyingPartyId
          Entity ID of the relying party.
private  String requestBinding
          URI of binding used by the relying party.
private  String requestId
          Unique ID of the request message.
private  String responseBinding
          URI of binding used to respond to relying party.
private  String responseId
          Unqiue ID of the response message.
 
Constructor Summary
AuditLogEntry()
          Constructor.
 
Method Summary
 String getAssertingPartyId()
          Gets the provider (message issuer) ID.
 org.joda.time.DateTime getAuditEventTime()
          Gets the timestamp for this audit event.
 String getMessageProfile()
          Gets the URI of the message profile being used.
 String getNameIdValue()
          Gets the value of the SAML name identifier.
 String getPrincipalAuthenticationMethod()
          Gets the authentication method, identified by their URI, used to log into the relying party.
 String getPrincipalName()
          Gets the principal ID of the user.
 List<String> getReleasedAttributes()
          Gets the list of internal IDs of the attributes that were released.
 String getRelyingPartyId()
          Gets the entity ID of the relying party.
 String getRequestBinding()
          Gets the URI of the binding used during the request.
 String getRequestId()
          Gets the unique ID of the request.
 String getResponseBinding()
          Gets the URI of the binding used during the response.
 String getResponseId()
          Gets the unique ID of the response message.
 void setAssertingPartyId(String id)
          Sets the provider (message issuer) ID.
 void setMessageProfile(String profileURI)
          Sets the URI of the message profile being used.
 void setNameIdValue(String value)
          Sets the value of the SAML name identifier.
 void setPrincipalAuthenticationMethod(String method)
          Sets the authentication method, identified by their URI, used to log into the relying party.
 void setPrincipalName(String id)
          Sets the principal ID of the user.
 void setRelyingPartyId(String entityId)
          Sets the entity ID of the relying party.
 void setRequestBinding(String bindingURI)
          Sets the URI of the binding used during the request.
 void setRequestId(String id)
          Sets the unique ID of the request.
 void setResponseBinding(String bindingURI)
          Sets the URI of the binding used during the response.
 void setResponseId(String id)
          Sets the unique ID of the response message.
 String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

AUDIT_LOGGER_NAME

public static final String AUDIT_LOGGER_NAME
Name of the Logger for the shibboleth audit log.

See Also:
Constant Field Values

dateFormatter

private static org.joda.time.format.DateTimeFormatter dateFormatter
Formatter used to convert timestamps to strings.


auditEventTime

private org.joda.time.DateTime auditEventTime
UTC IS8601 timestamp of the audit event.


assertingPartyId

private String assertingPartyId
Entity ID of the provider (message issuer).


relyingPartyId

private String relyingPartyId
Entity ID of the relying party.


requestBinding

private String requestBinding
URI of binding used by the relying party.


responseBinding

private String responseBinding
URI of binding used to respond to relying party.


messageProfile

private String messageProfile
URI of profile in use.


requestId

private String requestId
Unique ID of the request message.


responseId

private String responseId
Unqiue ID of the response message.


principalName

private String principalName
Principal ID of the user the request was made about.


principalAuthenticationMethod

private String principalAuthenticationMethod
URIs of the authentication methods currently active for the user.


releasedAttributes

private List<String> releasedAttributes
Internal ID of the user attributes released.


nameIdValue

private String nameIdValue
Value of the SAML name identifier.

Constructor Detail

AuditLogEntry

public AuditLogEntry()
Constructor.

Method Detail

getAssertingPartyId

public String getAssertingPartyId()
Gets the provider (message issuer) ID.

Returns:
provider (message issuer) ID

getAuditEventTime

public org.joda.time.DateTime getAuditEventTime()
Gets the timestamp for this audit event.

Returns:
timestamp for this audit event

getMessageProfile

public String getMessageProfile()
Gets the URI of the message profile being used.

Returns:
URI of the message profile being used

getNameIdValue

public String getNameIdValue()
Gets the value of the SAML name identifier.

Returns:
value of the SAML name identifier

getPrincipalAuthenticationMethod

public String getPrincipalAuthenticationMethod()
Gets the authentication method, identified by their URI, used to log into the relying party.

Returns:
authentication method, identified by their URI, used to log into the relying party

getPrincipalName

public String getPrincipalName()
Gets the principal ID of the user.

Returns:
principal ID of the user

getReleasedAttributes

public List<String> getReleasedAttributes()
Gets the list of internal IDs of the attributes that were released.

Returns:
internal IDs of the attributes that were released

getRelyingPartyId

public String getRelyingPartyId()
Gets the entity ID of the relying party.

Returns:
entity ID of the relying party

getRequestBinding

public String getRequestBinding()
Gets the URI of the binding used during the request.

Returns:
URI of the binding used during the request

getRequestId

public String getRequestId()
Gets the unique ID of the request.

Returns:
unique ID of the request

getResponseBinding

public String getResponseBinding()
Gets the URI of the binding used during the response.

Returns:
URI of the binding used during the response

getResponseId

public String getResponseId()
Gets the unique ID of the response message.

Returns:
unique ID of the response message

setAssertingPartyId

public void setAssertingPartyId(String id)
Sets the provider (message issuer) ID.

Parameters:
id - provider (message issuer) ID

setMessageProfile

public void setMessageProfile(String profileURI)
Sets the URI of the message profile being used.

Parameters:
profileURI - URI of the message profile being used

setNameIdValue

public void setNameIdValue(String value)
Sets the value of the SAML name identifier.

Parameters:
value - value of the SAML name identifier

setPrincipalAuthenticationMethod

public void setPrincipalAuthenticationMethod(String method)
Sets the authentication method, identified by their URI, used to log into the relying party.

Parameters:
method - authentication method, identified by their URI, used to log into the relying party

setPrincipalName

public void setPrincipalName(String id)
Sets the principal ID of the user.

Parameters:
id - principal ID of the user

setRelyingPartyId

public void setRelyingPartyId(String entityId)
Sets the entity ID of the relying party.

Parameters:
entityId - entity ID of the relying party

setRequestBinding

public void setRequestBinding(String bindingURI)
Sets the URI of the binding used during the request.

Parameters:
bindingURI - URI of the binding used during the request

setRequestId

public void setRequestId(String id)
Sets the unique ID of the request.

Parameters:
id - unique ID of the request

setResponseBinding

public void setResponseBinding(String bindingURI)
Sets the URI of the binding used during the response.

Parameters:
bindingURI - URI of the binding used during the response

setResponseId

public void setResponseId(String id)
Sets the unique ID of the response message.

Parameters:
id - unique ID of the response message

toString

public String toString()

Overrides:
toString in class Object


Copyright © 1999-2012. All Rights Reserved.