Apache CXF API

org.apache.cxf.sts.token.provider
Class SCTProvider

java.lang.Object
  extended by org.apache.cxf.sts.token.provider.SCTProvider
All Implemented Interfaces:
TokenProvider

public class SCTProvider
extends Object
implements TokenProvider

A TokenProvider implementation that provides a SecurityContextToken.


Constructor Summary
SCTProvider()
           
 
Method Summary
 boolean canHandleToken(String tokenType)
          Return true if this TokenProvider implementation is capable of providing a token that corresponds to the given TokenType.
 boolean canHandleToken(String tokenType, String realm)
          Return true if this TokenProvider implementation is capable of providing a token that corresponds to the given TokenType in a given realm.
 TokenProviderResponse createToken(TokenProviderParameters tokenParameters)
          Create a token given a TokenProviderParameters
 long getLifetime()
          Return the lifetime of the generated SCT
 boolean isReturnEntropy()
          Get whether Entropy is returned to the client or not
 void setLifetime(long lifetime)
          Set the lifetime of the generated SCT
 void setReturnEntropy(boolean returnEntropy)
          Set whether Entropy is returned to the client or not
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SCTProvider

public SCTProvider()
Method Detail

getLifetime

public long getLifetime()
Return the lifetime of the generated SCT

Returns:
the lifetime of the generated SCT

setLifetime

public void setLifetime(long lifetime)
Set the lifetime of the generated SCT

Parameters:
lifetime - the lifetime of the generated SCT

canHandleToken

public boolean canHandleToken(String tokenType)
Return true if this TokenProvider implementation is capable of providing a token that corresponds to the given TokenType.

Specified by:
canHandleToken in interface TokenProvider

canHandleToken

public boolean canHandleToken(String tokenType,
                              String realm)
Return true if this TokenProvider implementation is capable of providing a token that corresponds to the given TokenType in a given realm. The realm is ignored in this token provider.

Specified by:
canHandleToken in interface TokenProvider

setReturnEntropy

public void setReturnEntropy(boolean returnEntropy)
Set whether Entropy is returned to the client or not

Parameters:
returnEntropy - whether Entropy is returned to the client or not

isReturnEntropy

public boolean isReturnEntropy()
Get whether Entropy is returned to the client or not

Returns:
whether Entropy is returned to the client or not

createToken

public TokenProviderResponse createToken(TokenProviderParameters tokenParameters)
Create a token given a TokenProviderParameters

Specified by:
createToken in interface TokenProvider

Apache CXF API

Apache CXF