IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.wssecurity.wssapi
Class WSSFactory

java.lang.Object
  extended by com.ibm.websphere.wssecurity.wssapi.WSSFactory

public abstract class WSSFactory
extends java.lang.Object

This abstract class is responsible for the creation of classes that are required for WS-Security generation and consumption.


Constructor Summary
WSSFactory()
           
 
Method Summary
static WSSFactory getInstance()
          Instanciates WSSFactory itself.
abstract  SecurityToken newSecurityToken(java.lang.Class tokenClass, javax.security.auth.callback.CallbackHandler callbackHandler)
          Instanciates the security token class.
abstract  SecurityToken newSecurityToken(java.lang.Class tokenClass, javax.security.auth.callback.CallbackHandler callbackHandler, java.lang.String loginConfigName)
          Instanciates the security token class.
abstract  SecurityToken[] newSecurityTokens(java.lang.Class[] tokenClasses, javax.security.auth.callback.CallbackHandler callbackHandler)
          Instanciates the security token classes.
abstract  SecurityToken[] newSecurityTokens(java.lang.Class[] tokenClasses, javax.security.auth.callback.CallbackHandler callbackHandler, java.lang.String loginConfigName)
          Instanciates some security token classes.
abstract  WSSConsumingContext newWSSConsumingContext()
          Instanciate the WSSConsumingContext class, which stored the comsuption components.
abstract  WSSConsumingContext newWSSConsumingContext(java.lang.String actor)
          Instanciate the WSSConsumingContext class, which stored the comsuption components.
abstract  WSSDecryption newWSSDecryption()
          Instantiates the WSSDecryption class.
abstract  WSSDecryption newWSSDecryption(java.lang.Class tokenClass)
          Instantiates the WSSDecryption class.
abstract  WSSDecryption newWSSDecryption(java.lang.Class tokenClass, javax.security.auth.callback.CallbackHandler callbackHandler)
          Instantiates the WSSDecryption class.
abstract  WSSDecryption newWSSDecryption(java.lang.Class tokenClass, javax.security.auth.callback.CallbackHandler callbackHandler, java.lang.String loginConfigName)
          Instantiates the WSSDecryption class.
abstract  WSSDecryptPart newWSSDecryptPart()
          Instantiates the WSSDecryptPart class.
abstract  WSSEncryption newWSSEncryption()
          Instantiates the WSSEncryption class.
abstract  WSSEncryption newWSSEncryption(SecurityToken token)
          Instantiates the WSSEncryption class.
abstract  WSSEncryptPart newWSSEncryptPart()
          Instanciates the WSSEncryptPart class.
abstract  WSSGenerationContext newWSSGenerationContext()
          Instanciates the WSSGenerationContext class.
abstract  WSSGenerationContext newWSSGenerationContext(java.lang.String actor)
          Instanciates the WSSGenerationContext class.
abstract  WSSSignature newWSSSignature(SecurityToken token)
          Instanciates the WSSSignature class.
abstract  WSSSignPart newWSSSignPart()
          Instanciates the WSSSignPart class.
abstract  WSSTimestamp newWSSTimestamp()
          Instanciates the WSSTimestamp class.
abstract  WSSVerification newWSSVerification(java.lang.Class tokenClass)
          Instanciates WSSVerification class.
abstract  WSSVerification newWSSVerification(java.lang.Class tokenClass, javax.security.auth.callback.CallbackHandler callbackHandler)
          Instanciates WSSVerification class.
abstract  WSSVerification newWSSVerification(java.lang.Class tokenClass, javax.security.auth.callback.CallbackHandler callbackHandler, java.lang.String loginConfigName)
          Instanciates WSSVerification class.
abstract  WSSVerifyPart newWSSVerifyPart()
          Instanciates the WSSVerifyPart class.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WSSFactory

public WSSFactory()
Method Detail

getInstance

public static WSSFactory getInstance()
                              throws WSSException
Instanciates WSSFactory itself.

Returns:
WSSFactory object
Throws:
WSSException - if the illegal access occurs or if the WSSFactory instance is not generated.

newWSSGenerationContext

public abstract WSSGenerationContext newWSSGenerationContext()
Instanciates the WSSGenerationContext class.

Returns:
WSSGenerationContext object

newWSSGenerationContext

public abstract WSSGenerationContext newWSSGenerationContext(java.lang.String actor)
Instanciates the WSSGenerationContext class.

Parameters:
actor - the actor
Returns:
WSSGenerationContext object

newWSSConsumingContext

public abstract WSSConsumingContext newWSSConsumingContext()
Instanciate the WSSConsumingContext class, which stored the comsuption components.

Returns:
WSSConsumingContext object

newWSSConsumingContext

public abstract WSSConsumingContext newWSSConsumingContext(java.lang.String actor)
Instanciate the WSSConsumingContext class, which stored the comsuption components.

Parameters:
actor - the actor
Returns:
WSSConsumingContext object

newWSSSignature

public abstract WSSSignature newWSSSignature(SecurityToken token)
Instanciates the WSSSignature class.

Parameters:
token - the security token with key for the purpose the signature
Returns:
WSSSignature object

newWSSSignPart

public abstract WSSSignPart newWSSSignPart()
Instanciates the WSSSignPart class.

Returns:
WSSSignPart object

newWSSEncryption

public abstract WSSEncryption newWSSEncryption(SecurityToken token)
Instantiates the WSSEncryption class.

Parameters:
token - the security token with key for the purpose the encryption.
Returns:
WSSEncryption object

newWSSEncryption

public abstract WSSEncryption newWSSEncryption()
Instantiates the WSSEncryption class.

Returns:
WSSEncryption object

newWSSEncryptPart

public abstract WSSEncryptPart newWSSEncryptPart()
Instanciates the WSSEncryptPart class.

Returns:
WSSEncryptPart object

newWSSTimestamp

public abstract WSSTimestamp newWSSTimestamp()
                                      throws WSSException
Instanciates the WSSTimestamp class.

Returns:
WSSTimestamp object
Throws:
WSSException - the error occurs in parsing the duration time

newSecurityToken

public abstract SecurityToken newSecurityToken(java.lang.Class tokenClass,
                                               javax.security.auth.callback.CallbackHandler callbackHandler,
                                               java.lang.String loginConfigName)
                                        throws WSSException
Instanciates the security token class.

Parameters:
tokenClass - class of the security token
callbackHandler - callback handler
loginConfigName - name of the JAAS login configuration
Returns:
security token object
Throws:
WSSException - if the SecurityToken instance is not generated

newSecurityTokens

public abstract SecurityToken[] newSecurityTokens(java.lang.Class[] tokenClasses,
                                                  javax.security.auth.callback.CallbackHandler callbackHandler,
                                                  java.lang.String loginConfigName)
                                           throws WSSException
Instanciates some security token classes. This method is for WS-SecureConversation.

Parameters:
classes - of the security token
callbackHandler - callback handler
loginConfigName - name of the JAAS login configuration
Returns:
security token objects
Throws:
WSSException - if the SecurityToken instances are not generated

newSecurityToken

public abstract SecurityToken newSecurityToken(java.lang.Class tokenClass,
                                               javax.security.auth.callback.CallbackHandler callbackHandler)
                                        throws WSSException
Instanciates the security token class.

Parameters:
tokenClass - class of the security token
callbackHandler - callback handler
Returns:
security token object
Throws:
WSSException - if the SecurityToken instance is not generated

newSecurityTokens

public abstract SecurityToken[] newSecurityTokens(java.lang.Class[] tokenClasses,
                                                  javax.security.auth.callback.CallbackHandler callbackHandler)
                                           throws WSSException
Instanciates the security token classes. This method is for WS-SecureConversation.

Parameters:
classes - of the security token
callbackHandler - callback handler
Returns:
security token objects
Throws:
WSSException - if the SecurityToken instances are not generated

newWSSVerification

public abstract WSSVerification newWSSVerification(java.lang.Class tokenClass)
                                            throws WSSException
Instanciates WSSVerification class.

Parameters:
tokenClass - class of the security token
Returns:
WSSVerification object
Throws:
WSSException - if the tokenClass is not valid

newWSSVerification

public abstract WSSVerification newWSSVerification(java.lang.Class tokenClass,
                                                   javax.security.auth.callback.CallbackHandler callbackHandler)
                                            throws WSSException
Instanciates WSSVerification class.

Parameters:
tokenClass - class of the security token
callbackHandler - callback handler
Returns:
WSSVerification object
Throws:
WSSException - if the arguments is not valid

newWSSVerification

public abstract WSSVerification newWSSVerification(java.lang.Class tokenClass,
                                                   javax.security.auth.callback.CallbackHandler callbackHandler,
                                                   java.lang.String loginConfigName)
                                            throws WSSException
Instanciates WSSVerification class.

Parameters:
tokenClass - class of the security token
callbackHandler - callback handler
loginConfigName - name of the JAAS login configuration
Returns:
WSSVerification object
Throws:
WSSException - if the arguments are not valid

newWSSVerifyPart

public abstract WSSVerifyPart newWSSVerifyPart()
Instanciates the WSSVerifyPart class.

Returns:
WSSVerifyPart object

newWSSDecryption

public abstract WSSDecryption newWSSDecryption(java.lang.Class tokenClass,
                                               javax.security.auth.callback.CallbackHandler callbackHandler,
                                               java.lang.String loginConfigName)
                                        throws WSSException
Instantiates the WSSDecryption class.

Parameters:
tokenClass - class of the security token
callbackHandler - callback handler
loginConfigName - name of the JAAS login configuration
Returns:
WSSDecryption object
Throws:
WSSException - if the arguments are not valid

newWSSDecryption

public abstract WSSDecryption newWSSDecryption(java.lang.Class tokenClass,
                                               javax.security.auth.callback.CallbackHandler callbackHandler)
                                        throws WSSException
Instantiates the WSSDecryption class.

Parameters:
tokenClass - classClass of the security token
callbackHandler - callback handler
Returns:
WSSDecryption object
Throws:
WSSException - if the arguments are not valid

newWSSDecryption

public abstract WSSDecryption newWSSDecryption(java.lang.Class tokenClass)
                                        throws WSSException
Instantiates the WSSDecryption class.

Parameters:
tokenClass - class of the security token
Returns:
WSSDecryption object
Throws:
WSSException - if the tokenClass is not valid

newWSSDecryption

public abstract WSSDecryption newWSSDecryption()
Instantiates the WSSDecryption class.

Returns:
WSSDecryption object

newWSSDecryptPart

public abstract WSSDecryptPart newWSSDecryptPart()
Instantiates the WSSDecryptPart class.

Returns:
WSSDecryptPart object

IBM WebSphere Application ServerTM
Release 8