This is the main interface for the JASIG portal effort's security
mechanism. We endeavor here to provide considerable encapsulation of
the data we are trying to present.
author: Andrew Newman, newman@yale.edu version: $Revision: 34783 $ author: Don Fracapane (df7@columbia.edu) author: Added getSubContextNames() to support principal and credential tokens
Method Summary
public void
addSubContext(String name, ISecurityContext ctx) Adds a named sub context to the list of subserviant subcontexts.
Parameters: name - The non-compound name of the subserviant context.
public void
authenticate() Performs the operation of authentication.
Adds a named sub context to the list of subserviant subcontexts.
Parameters: name - The non-compound name of the subserviant context. Note thatunder normal circumstances the establishment of the InitialSecurityContextwill automatically register all subcontext. Parameters: ctx - The security context object to register.
Performs the operation of authentication. To perform this operation, the
values set in the Principal object (whose reference is
returned by getPrincipalInstance()) and the
OpaqueCredentials object (whose reference is returned
by getOpaqueCredentialsInstance()).
See Also:ISecurityContext.getPrincipalInstance See Also:ISecurityContext.getOpaqueCredentialsInstance
Returns any additional descriptor information that might have been acquired
during the process of authentication. Note that this interface has no
methods and the object returned will have to be cast to some concrete
type or alternate interface to be useful.
An object containing any additional descriptor information. See Also:IAdditionalDescriptor
Returns the canonical authentication type for this flavor of
authentication. Each value returned should be either a globally registered
auth flavor or a local variant.
The unique authentication value identifier. Values with thehigh order 16 bits clear are local (0x0000 - 0x00FF) where values with thehigh order 16 bits set (0xFF00 - 0xFFFF are foundation types distributedby JASIG. All other should be registered and globally unique.
Returns any credentials that an authenticated principal currently
has. Note that opaque credentials don't have any methods for examination
of the credentials contents. This call would primarily be useful to
chain authentication manually within the same authentication schem.
The currently authenticated credentials object. See Also:IOpaqueCredentials
Returns an empty object reference to an object implementing the
IOpaqueCredentials interface. By operating on this returned object
the implementation class for the credentials type will be able to
access any values set in the Opaque credentials without exposing an
interface method that would allow others to access the fields.
An empty credentials container. See Also:IOpaqueCredentials
Returns the currently authenticated principal if we are currently
authenticated. Note that merely testing this for a non-null pointer
is not sufficient to verify authenticated status. The isAuthenticated()
call should be used. In some authentication schemes, an asyncronous
event could potentially change one's authentication status.
The currently authenticated principal.
Returns an empty object reference to an object implementing the
Principal interface. By operating on this returned object the
implementation class for the credentials type will be able to access
any values set in the instance without exposing an interface method that
would allow others (inappropriate) acces to the fields.
An empty principal container. See Also:IPrincipal
Returns an ISecurityContext for the named subserviant security
context.
The security context object reference associated with thename specified as the first parameter. Parameters: ctx - The non-compound name of the subserviant security context.
Returns an enumeration of the names of the security contexts currently
registered as being subserviant to this one.
The enumeration object containing all of the subcontext names.
Returns an enumeration of the security contexts currently registered as
being subserviant to this one.
The enumeration object containing all of the contexts.
Returns a boolean status as to whether the descriptor corresponds to an
authenticated principal. Note that the get(Principaal|OpaqueCredentials)
calls return null until isAuthenticated first returns true.