com.eibus.security.identity

Interface Identity

public interface Identity

Represents the identity of a user within a certain organization.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Identity.IdentityValidationResult Possible statuses of a Identity after validation.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToSoapMessage(int soapMessageNode) Add this Identity to a given SOAP message.
java.lang.String	getOrgUserDN() Returns a String representation of a LDAP DN for a user.
java.lang.String	getUserId() Returns a String representation of the Identity containing only the external user Id (also called os identity).
java.lang.String	getUserOrganization() Returns the organizational LDAP DN of the User Identity
Identity.IdentityValidationResult	validate() Internal method to check if the Identity can be trusted.

Method Detail

getOrgUserDN

java.lang.String getOrgUserDN()

Returns a String representation of a LDAP DN for a user. This is used to match ACL with users.

Returns:

the DN of the organizational user as a String

getUserId

java.lang.String getUserId()

Returns a String representation of the Identity containing only the external user Id (also called os identity).

Returns:

String containing the user Id.

getUserOrganization

java.lang.String getUserOrganization()

Returns the organizational LDAP DN of the User Identity

Returns:

String representation of the organizational context.

addToSoapMessage

void addToSoapMessage(int soapMessageNode)
                      throws XMLException

Add this Identity to a given SOAP message. This will add the user credentials to the SOAP message depending on the type of identity.

Parameters:

soapMessageNode - the soap message to add this identity to

Throws:

XMLException - when XML construction fails

validate

Identity.IdentityValidationResult validate()
                                           throws com.eibus.security.identity.IdentityValidationException

Internal method to check if the Identity can be trusted. This method is idempotent.

Returns:

IdentityValidationResult indicating the state of the Identity

Throws:

com.eibus.security.identity.IdentityValidationException