Oracle Entitlements Server for Java API Reference

com.bea.security
Class AuthenticIdentity

java.lang.Object
  |
  +--com.bea.security.AuthenticIdentity

public class AuthenticIdentity

extends java.lang.Object

implements weblogic.security.acl.internal.AuthenticIdentityIntf

The AuthenticIdentity class represents an authenticated Identity. There is also a special case of AuthenticIdentity that represents the anonymous, or non-authenticated, user.

Author:

Copyright © 2004-2008, Oracle and/or its affiliates. All rights reserved.

Method Summary

java.lang.Object	convert(java.lang.String type) Convert this identity into another format given by the type.
java.lang.String[]	getConversionTypes() Get a list of the types that this identity may be converted to.
java.lang.Object	getNativeIdentity() Get the stored native identity
PolicyDomain	getPolicyDomain() Get a reference to the policy domain that has authenticated this identity.
java.lang.String	toString() Converts this identity to a human readable String.

Methods inherited from class java.lang.Object

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

Method Detail

toString

public java.lang.String toString()

Converts this identity to a human readable String. It is important to note that this string does not contain proper encodings to validate this identity ( this requires an identity assertion token ) but is intended to be used more for debugging and logging.

Returns:

a String that is a human readable description of this identity.

Overrides:

toString in class java.lang.Object

getPolicyDomain

public PolicyDomain getPolicyDomain()

Get a reference to the policy domain that has authenticated this identity. This will be null for the anonymous user.

Returns:

the PolicyDomain that has authenticated this user.

convert

public java.lang.Object convert(java.lang.String type)
                         throws ServiceNotAvailableException

Convert this identity into another format given by the type.

Parameters:

type - the fully qualified classname to convert this identity.

Returns:

a java.lang.Object which can be cast to the requested type.

Throws:

ServiceNotAvailableException - This exception is thrown the type asked for is not supported.

getConversionTypes

public java.lang.String[] getConversionTypes()

Get a list of the types that this identity may be converted to.

Returns:

an array of Strings containing the fully qualified class or interfaces names that this identity can be converted to.

getNativeIdentity

public java.lang.Object getNativeIdentity()

Get the stored native identity

Specified by:

getNativeIdentity in interface weblogic.security.acl.internal.AuthenticIdentityIntf

Returns:

null indicates no identity - ANONYMOUS is a specific identity