|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
void |
addSubContext(java.lang.String name,
ISecurityContext ctx)
Adds a named sub context to the list of subserviant subcontexts. |
void |
authenticate()
Performs the operation of authentication. |
IAdditionalDescriptor |
getAdditionalDescriptor()
Returns any additional descriptor information that might have been acquired during the process of authentication. |
int |
getAuthType()
Returns the canonical authentication type for this flavor of authentication. |
IOpaqueCredentials |
getOpaqueCredentials()
Returns any credentials that an authenticated principal currently has. |
IOpaqueCredentials |
getOpaqueCredentialsInstance()
Returns an empty object reference to an object implementing the IOpaqueCredentials interface. |
IPrincipal |
getPrincipal()
Returns the currently authenticated principal if we are currently authenticated. |
IPrincipal |
getPrincipalInstance()
Returns an empty object reference to an object implementing the Principal interface. |
ISecurityContext |
getSubContext(java.lang.String ctx)
Returns an ISecurityContext for the named subserviant security
context. |
java.util.Enumeration |
getSubContextNames()
Returns an enumeration of the names of the security contexts currently registered as being subserviant to this one. |
java.util.Enumeration |
getSubContexts()
Returns an enumeration of the security contexts currently registered as being subserviant to this one. |
boolean |
isAuthenticated()
Returns a boolean status as to whether the descriptor corresponds to an authenticated principal. |
Method Detail |
public int getAuthType()
public IPrincipal getPrincipalInstance()
IPrincipal
public IOpaqueCredentials getOpaqueCredentialsInstance()
IOpaqueCredentials
public void authenticate() throws PortalSecurityException
getPrincipalInstance()
) and the
OpaqueCredentials object (whose reference is returned
by getOpaqueCredentialsInstance()
).
PortalSecurityException
getPrincipalInstance()
,
getOpaqueCredentialsInstance()
public IPrincipal getPrincipal()
public IOpaqueCredentials getOpaqueCredentials()
IOpaqueCredentials
public IAdditionalDescriptor getAdditionalDescriptor()
IAdditionalDescriptor
public boolean isAuthenticated()
true
.
public ISecurityContext getSubContext(java.lang.String ctx) throws PortalSecurityException
ISecurityContext
for the named subserviant security
context.
ctx
- The non-compound name of the subserviant security context.
PortalSecurityException
public java.util.Enumeration getSubContexts()
public java.util.Enumeration getSubContextNames()
public void addSubContext(java.lang.String name, ISecurityContext ctx) throws PortalSecurityException
name
- The non-compound name of the subserviant context. Note that
under normal circumstances the establishment of the InitialSecurityContext
will automatically register all subcontext.ctx
- The security context object to register.
PortalSecurityException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |