com.sun.identity.liberty.ws.security

Interface SecurityTokenManagerIF

All Superinterfaces:

Remote

All Known Implementing Classes:

SecurityTokenManagerImpl

public interface SecurityTokenManagerIF
extends Remote

This is the JAX-RPC interface for making SecurityTokenManager remotable.

Method Summary

Modifier and Type	Method and Description
void	checkForLocal() Checks if the service is available locally.
String	getSAMLAuthenticationToken(String senderIdentity) Returns the SAML Authentication Token.
String	getSAMLAuthorizationToken(String senderIdentity, String invocatorSession, String resourceID, boolean encryptedID, boolean includeAuthN, boolean includeResourceAccessStatement, String recipientProviderID) Returns the SAML Authorization Token.
String	getX509CertificateToken() Returns the Certificate Token.
void	initialization(String sessionID) Initializes the SecurityTokenManager.
void	setCertificate(String cert, boolean alias) Sets the Certificate.

Method Detail

initialization

void initialization(String sessionID)
             throws SecurityTokenException,
                    RemoteException

Initializes the SecurityTokenManager.

Parameters:

sessionID - the session id.

Throws:

SecurityTokenException - if there is an error.

RemoteException - if there is an error.

checkForLocal

void checkForLocal()
            throws RemoteException

Checks if the service is available locally.

Throws:

RemoteException - if there is an error.

setCertificate

void setCertificate(String cert,
                    boolean alias)
             throws SecurityTokenException,
                    RemoteException

Sets the Certificate.

Parameters:

cert - the Certificate String.

alias - if true then Certificate Alias will be set.

Throws:

SecurityTokenException - if there is an error.

RemoteException - if there is an error.

getX509CertificateToken

String getX509CertificateToken()
                        throws SecurityTokenException,
                               RemoteException

Returns the Certificate Token.

Returns:

the Certification Token String.

Throws:

SecurityTokenException - if there is an error.

RemoteException - if there is an error.

getSAMLAuthenticationToken

String getSAMLAuthenticationToken(String senderIdentity)
                           throws SecurityTokenException,
                                  SAMLException,
                                  RemoteException

Returns the SAML Authentication Token.

Parameters:

senderIdentity - the sender's identity.

Returns:

the SAML Authentication Token String.

Throws:

SecurityTokenException - if there is an error.

SAMLException - if there is an error.

RemoteException - if there is an error.

getSAMLAuthorizationToken

String getSAMLAuthorizationToken(String senderIdentity,
                                 String invocatorSession,
                                 String resourceID,
                                 boolean encryptedID,
                                 boolean includeAuthN,
                                 boolean includeResourceAccessStatement,
                                 String recipientProviderID)
                          throws SecurityTokenException,
                                 SAMLException,
                                 RemoteException

Returns the SAML Authorization Token.

Parameters:

senderIdentity - the identity of the sender.

invocatorSession - the session identifier

resourceID - the resource Identifier.

encryptedID - boolean value to determine if the identifier is encrypted.

includeAuthN - boolean value to deteremine if the authentication information should be included.

includeResourceAccessStatement - if true, a ResourceAccessStatement will be included in the Assertion (for AuthorizeRequester directive). If false, a SessionContextStatement will be included in the Assertion (for AuthenticationSessionContext directive). In the case when both AuthorizeRequester and AuthenticationSessionContext directive need to be handled, use "true" as parameter here since the SessionContext will always be included in the ResourceAccessStatement.

recipientProviderID - recipient's provider ID.

Returns:

the SAML Authorization Token String.

Throws:

SecurityTokenException - if there is an error.

SAMLException - if there is an error.

RemoteException - if there is an error.