IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.wssecurity.callbackhandler
Class SCTGenerateCallbackHandler

java.lang.Object
  extended by com.ibm.websphere.wssecurity.callbackhandler.SCTGenerateCallbackHandler
All Implemented Interfaces:
java.io.Serializable, javax.security.auth.callback.CallbackHandler

public class SCTGenerateCallbackHandler
extends java.lang.Object
implements javax.security.auth.callback.CallbackHandler, java.io.Serializable

This class is a callback handler for security context token in generator side. This instance is used to generate WSSSignature object and WSSEncryption object to generate a security context token.
If the dispach object is set, the implementation prioritize the policy set or WSSAPI. When the policy set is applied to the application, the WSSAPI will be disabled.

See Also:
SecurityContextToken, SCTGenerateCallback, Serialized Form

Constructor Summary
SCTGenerateCallbackHandler(SecurityContextToken token, WSSGenerationContext gencont, WSSConsumingContext concont, java.lang.String signatureAlgorithm, int signatureKeyLength, java.lang.String encryptionAlgorithm, int encryptionKeyLength, java.lang.String serviceLabel, java.lang.String clientLabel)
          Class constructor
SCTGenerateCallbackHandler(SecurityContextToken token, WSSGenerationContext gencont, WSSConsumingContext concont, java.lang.String signatureAlgorithm, int signatureKeyLength, java.lang.String encryptionAlgorithm, int encryptionKeyLength, java.lang.String serviceLabel, java.lang.String clientLabel, javax.xml.ws.Dispatch dispatch)
          Class constructor
SCTGenerateCallbackHandler(WSSGenerationContext gencont, WSSConsumingContext concont)
          Class constructor
SCTGenerateCallbackHandler(WSSGenerationContext gencont, WSSConsumingContext concont, javax.xml.ws.Dispatch dispatch)
          Class constructor
SCTGenerateCallbackHandler(WSSGenerationContext gencont, WSSConsumingContext concont, java.lang.String serviceEndpointAddress, boolean requiredDKT)
          Class constructor
SCTGenerateCallbackHandler(WSSGenerationContext gencont, WSSConsumingContext concont, java.lang.String serviceEndpointAddress, boolean requiredDKT, javax.xml.ws.Dispatch dispatch)
          Class constructor
SCTGenerateCallbackHandler(WSSGenerationContext gencont, WSSConsumingContext concont, java.lang.String serviceEndpointAddress, javax.xml.ws.Dispatch dispatch)
          Class constructor
SCTGenerateCallbackHandler(WSSGenerationContext gencont, WSSConsumingContext concont, java.lang.String serviceEndpointAddress, java.lang.String encryptionAlgorithm)
          Class constructor
 
Method Summary
 java.lang.String getClientLabel()
          Returns the label for client.
 int getKeyBytesLength()
           
 int getNonceBytesLength()
           
 boolean getRequiredDKT()
           
 java.lang.String getServerLabel()
          Returns the label for service.
 void handle(javax.security.auth.callback.Callback[] callbacks)
          Sets necessary information to a SCTGenerateCallback object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SCTGenerateCallbackHandler

public SCTGenerateCallbackHandler(WSSGenerationContext gencont,
                                  WSSConsumingContext concont,
                                  java.lang.String serviceEndpointAddress,
                                  boolean requiredDKT)
Class constructor

Parameters:
gencont - WSSGenerationContext object
concont - WSSConsumingContext object
serviceEndpointAddress - the address to require the security context token
requiredDKT - whether the derived key token is required or not

SCTGenerateCallbackHandler

public SCTGenerateCallbackHandler(WSSGenerationContext gencont,
                                  WSSConsumingContext concont,
                                  java.lang.String serviceEndpointAddress,
                                  java.lang.String encryptionAlgorithm)
Class constructor

Parameters:
gencont - WSSGenerationContext object
concont - WSSConsumingContext object
serviceEndpointAddress - the address to require the security context token
encryptionAlgorithm - the algorithm for the encryption

SCTGenerateCallbackHandler

public SCTGenerateCallbackHandler(WSSGenerationContext gencont,
                                  WSSConsumingContext concont)
Class constructor

Parameters:
gencont - WSSGenerationContext object
concont - WSSConsumingContext object

SCTGenerateCallbackHandler

public SCTGenerateCallbackHandler(SecurityContextToken token,
                                  WSSGenerationContext gencont,
                                  WSSConsumingContext concont,
                                  java.lang.String signatureAlgorithm,
                                  int signatureKeyLength,
                                  java.lang.String encryptionAlgorithm,
                                  int encryptionKeyLength,
                                  java.lang.String serviceLabel,
                                  java.lang.String clientLabel)
Class constructor

Parameters:
token - the security context token
gencont - WSSGenerationContext object
concont - WSSConsumingContext object
signatureAlgorithm - the algorithm for the signature
signatureKeyLength - the length of key for the signature (bytes)
encryptionAlgorithm - the algorithm for the encryption
encryptionKeyLength - the length of key for the encryption (bytes)
serverLabel - the server label
clientLabel - the client label

SCTGenerateCallbackHandler

public SCTGenerateCallbackHandler(WSSGenerationContext gencont,
                                  WSSConsumingContext concont,
                                  java.lang.String serviceEndpointAddress,
                                  boolean requiredDKT,
                                  javax.xml.ws.Dispatch dispatch)
Class constructor

Parameters:
gencont - WSSGenerationContext object
concont - WSSConsumingContext object
serviceEndpointAddress - the address to require the security context token
requiredDKT - whether the derived key token is required or not
dispatch - Dispatch of JAX-WS(@see javax.xml.ws.Dispatch)

SCTGenerateCallbackHandler

public SCTGenerateCallbackHandler(WSSGenerationContext gencont,
                                  WSSConsumingContext concont,
                                  java.lang.String serviceEndpointAddress,
                                  javax.xml.ws.Dispatch dispatch)
Class constructor

Parameters:
gencont - WSSGenerationContext object
concont - WSSConsumingContext object
serviceEndpointAddress - the address to require the security context token
dispatch - Dispatch of JAX-WS(@see javax.xml.ws.Dispatch)

SCTGenerateCallbackHandler

public SCTGenerateCallbackHandler(WSSGenerationContext gencont,
                                  WSSConsumingContext concont,
                                  javax.xml.ws.Dispatch dispatch)
Class constructor

Parameters:
gencont - WSSGenerationContext object
concont - WSSConsumingContext object
dispatch - Dispatch of JAX-WS(@see javax.xml.ws.Dispatch)

SCTGenerateCallbackHandler

public SCTGenerateCallbackHandler(SecurityContextToken token,
                                  WSSGenerationContext gencont,
                                  WSSConsumingContext concont,
                                  java.lang.String signatureAlgorithm,
                                  int signatureKeyLength,
                                  java.lang.String encryptionAlgorithm,
                                  int encryptionKeyLength,
                                  java.lang.String serviceLabel,
                                  java.lang.String clientLabel,
                                  javax.xml.ws.Dispatch dispatch)
Class constructor

Parameters:
token - the security context token
gencont - WSSGenerationContext object
concont - WSSConsumingContext object
signatureAlgorithm - the algorithm for the signature
signatureKeyLength - the length of key for the signature (bytes)
encryptionAlgorithm - the algorithm for the encryption
encryptionKeyLength - the length of key for the encryption (bytes)
serviceLabel - the service label
clientLabel - the client label
dispatch - Dispatch of JAX-WS(@see javax.xml.ws.Dispatch)
Method Detail

handle

public void handle(javax.security.auth.callback.Callback[] callbacks)
            throws java.io.IOException,
                   javax.security.auth.callback.UnsupportedCallbackException
Sets necessary information to a SCTGenerateCallback object.

Specified by:
handle in interface javax.security.auth.callback.CallbackHandler
Parameters:
callbacks - array of Callback objects provided by the underlying security service which contains the information requested to be retrieved or displayed.
Throws:
java.io.IOException - if an input or output error occurs.
javax.security.auth.callback.UnsupportedCallbackException - if the implementation of this method does not support one or more of the Callbacks specified in the callbacks parameter.
See Also:
CallbackHandler.handle(javax.security.auth.callback.Callback[])

getClientLabel

public java.lang.String getClientLabel()
Returns the label for client.

Returns:
client label

getServerLabel

public java.lang.String getServerLabel()
Returns the label for service.

Returns:
service label

getRequiredDKT

public boolean getRequiredDKT()

getKeyBytesLength

public int getKeyBytesLength()

getNonceBytesLength

public int getNonceBytesLength()

IBM WebSphere Application ServerTM
Release 7