org.apache.cxf.ws.security.trust
Class STSClient

java.lang.Object
  org.apache.cxf.ws.security.trust.STSClient

All Implemented Interfaces:

Configurable, InterceptorProvider

public class STSClient
extends Object
implements Configurable, InterceptorProvider

Constructor Summary

STSClient(Bus b)

Method Summary

boolean	cancelSecurityToken(SecurityToken token)
Element	getActAsToken() Get the "ActAs" element to be sent to the STS.
String	getBeanName() Get the configurable object's Bean name
Client	getClient()
String	getContext()
QName	getEndpointQName()
List<AbstractFeature>	getFeatures()
List<Interceptor<? extends Message>>	getInFaultInterceptors() Returns the list of interceptors attached to the incoming fault interceptor chain of the object.
List<Interceptor<? extends Message>>	getInInterceptors() Returns the list of interceptors attached to the incoming interceptor chain of the object.
int	getKeySize()
Element	getOnBehalfOfToken() Get the "OnBehalfOf" element to be sent to the STS.
List<Interceptor<? extends Message>>	getOutFaultInterceptors() Returns the list of interceptors attached to the outgoing fault interceptor chain of the object.
List<Interceptor<? extends Message>>	getOutInterceptors() Returns the list of interceptors attached to the outgoing interceptor chain of the object.
Map<String,Object>	getProperties()
Map<String,Object>	getRequestContext()
QName	getServiceQName()
String	getWsdlLocation()
boolean	isEnableAppliesTo()
boolean	isRequiresEntropy()
boolean	isSecureConv()
boolean	isUseCertificateForConfirmationKeyInfo()
void	renewSecurityToken(SecurityToken tok)
SecurityToken	requestSecurityToken()
SecurityToken	requestSecurityToken(String appliesTo)
SecurityToken	requestSecurityToken(String appliesTo, String action, String requestType, SecurityToken target)
void	setActAs(Object actAs)
void	setAddressingNamespace(String ad)
void	setAlgorithmSuite(AlgorithmSuite ag)
void	setBeanName(String s)
void	setContext(String context)
void	setEnableAppliesTo(boolean enableAppliesTo)
void	setEnableLifetime(boolean enableLifetime)
void	setEndpointName(String qn)
void	setEndpointQName(QName qn)
void	setFeatures(List<AbstractFeature> f)
void	setInFaultInterceptors(List<Interceptor<? extends Message>> interceptors)
void	setInInterceptors(List<Interceptor<? extends Message>> interceptors)
void	setKeySize(int i)
void	setKeyType(String keyType)
void	setLocation(String location)
void	setMessage(Message message)
void	setOnBehalfOf(Object onBehalfOf)
void	setOnBehalfOfElement(Element onBehalfOfElement) Deprecated.
void	setOutFaultInterceptors(List<Interceptor<? extends Message>> interceptors)
void	setOutInterceptors(List<Interceptor<? extends Message>> interceptors)
void	setPolicy(Object newPolicy) Sets the WS-P policy that is applied to communications between this client and the remote server if no value is supplied for setWsdlLocation(String).
protected void	setPolicyInternal(Element newPolicy)
protected void	setPolicyInternal(org.apache.neethi.Policy newPolicy)
void	setProperties(Map<String,Object> p)
void	setRequiresEntropy(boolean requiresEntropy)
void	setSecureConv(boolean secureConv)
void	setSendKeyType(boolean sendKeyType)
void	setServiceName(String qn)
void	setServiceQName(QName qn)
void	setSoap11()
void	setSoap11(boolean b)
void	setSoap12()
void	setTemplate(Element rstTemplate)
void	setTokenType(String tokenType)
void	setTrust(Trust10 trust)
void	setTrust(Trust13 trust)
void	setTtl(int ttl)
void	setUseCertificateForConfirmationKeyInfo(boolean useCertificate) Indicate whether to use the signer's public X509 certificate for the subject confirmation key info when creating a RequestsSecurityToken message.
void	setWsdlLocation(String wsdl)
List<SecurityToken>	validateSecurityToken(SecurityToken tok)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

STSClient

public STSClient(Bus b)

Method Detail

getBeanName

public String getBeanName()

Description copied from interface: Configurable

Get the configurable object's Bean name

Specified by:

getBeanName in interface Configurable

Returns:

the bean name

setBeanName

public void setBeanName(String s)

setLocation

public void setLocation(String location)

setMessage

public void setMessage(Message message)

setTtl

public void setTtl(int ttl)

setEnableLifetime

public void setEnableLifetime(boolean enableLifetime)

setPolicy

public void setPolicy(Object newPolicy)

Sets the WS-P policy that is applied to communications between this client and the remote server if no value is supplied for setWsdlLocation(String).

Accepts Policy or Element as input.

Parameters:

newPolicy - the policy object

Throws:

IllegalArgumentException - if newPolicy is not one of the supported types.

setSoap12

public void setSoap12()

setSoap11

public void setSoap11()

setSoap11

public void setSoap11(boolean b)

setAddressingNamespace

public void setAddressingNamespace(String ad)

setTrust

public void setTrust(Trust10 trust)

setTrust

public void setTrust(Trust13 trust)

isRequiresEntropy

public boolean isRequiresEntropy()

setRequiresEntropy

public void setRequiresEntropy(boolean requiresEntropy)

isSecureConv

public boolean isSecureConv()

setSecureConv

public void setSecureConv(boolean secureConv)

isEnableAppliesTo

public boolean isEnableAppliesTo()

setEnableAppliesTo

public void setEnableAppliesTo(boolean enableAppliesTo)

getContext

public String getContext()

setContext

public void setContext(String context)

setAlgorithmSuite

public void setAlgorithmSuite(AlgorithmSuite ag)

getRequestContext

public Map<String,Object> getRequestContext()

setProperties

public void setProperties(Map<String,Object> p)

getProperties

public Map<String,Object> getProperties()

setWsdlLocation

public void setWsdlLocation(String wsdl)

getWsdlLocation

public String getWsdlLocation()

setServiceName

public void setServiceName(String qn)

setEndpointName

public void setEndpointName(String qn)

setServiceQName

public void setServiceQName(QName qn)

getServiceQName

public QName getServiceQName()

setEndpointQName

public void setEndpointQName(QName qn)

getEndpointQName

public QName getEndpointQName()

setActAs

public void setActAs(Object actAs)

setKeySize

public void setKeySize(int i)

getKeySize

public int getKeySize()

setTokenType

public void setTokenType(String tokenType)

setSendKeyType

public void setSendKeyType(boolean sendKeyType)

setKeyType

public void setKeyType(String keyType)

setOnBehalfOfElement

@Deprecated
public void setOnBehalfOfElement(Element onBehalfOfElement)

Deprecated.

setOnBehalfOf

public void setOnBehalfOf(Object onBehalfOf)

setUseCertificateForConfirmationKeyInfo

public void setUseCertificateForConfirmationKeyInfo(boolean useCertificate)

Indicate whether to use the signer's public X509 certificate for the subject confirmation key info when creating a RequestsSecurityToken message. If the property is set to 'false', only the public key value will be provided in the request. If the property is set to 'true' the complete certificate will be sent in the request. Note: this setting is only applicable for assertions that use an asymmetric proof key

isUseCertificateForConfirmationKeyInfo

public boolean isUseCertificateForConfirmationKeyInfo()

setPolicyInternal

protected void setPolicyInternal(org.apache.neethi.Policy newPolicy)

setPolicyInternal

protected void setPolicyInternal(Element newPolicy)

getClient

public Client getClient()
                 throws BusException,
                        EndpointException

Throws:

BusException

EndpointException

requestSecurityToken

public SecurityToken requestSecurityToken()
                                   throws Exception

Throws:

Exception

requestSecurityToken

public SecurityToken requestSecurityToken(String appliesTo)
                                   throws Exception

Throws:

Exception

requestSecurityToken

public SecurityToken requestSecurityToken(String appliesTo,
                                          String action,
                                          String requestType,
                                          SecurityToken target)
                                   throws Exception

Throws:

Exception

getOnBehalfOfToken

public Element getOnBehalfOfToken()
                           throws Exception

Get the "OnBehalfOf" element to be sent to the STS.

Throws:

Exception

getActAsToken

public Element getActAsToken()
                      throws Exception

Get the "ActAs" element to be sent to the STS.

Throws:

Exception

renewSecurityToken

public void renewSecurityToken(SecurityToken tok)
                        throws Exception

Throws:

Exception

validateSecurityToken

public List<SecurityToken> validateSecurityToken(SecurityToken tok)
                                          throws Exception

Throws:

Exception

cancelSecurityToken

public boolean cancelSecurityToken(SecurityToken token)
                            throws Exception

Throws:

Exception

setTemplate

public void setTemplate(Element rstTemplate)

getOutFaultInterceptors

public List<Interceptor<? extends Message>> getOutFaultInterceptors()

Description copied from interface: InterceptorProvider

Returns the list of interceptors attached to the outgoing fault interceptor chain of the object.

Specified by:

getOutFaultInterceptors in interface InterceptorProvider

Returns:

List outgoing fault interceptor chain

getInFaultInterceptors

public List<Interceptor<? extends Message>> getInFaultInterceptors()

Description copied from interface: InterceptorProvider

Returns the list of interceptors attached to the incoming fault interceptor chain of the object.

Specified by:

getInFaultInterceptors in interface InterceptorProvider

Returns:

List incoming fault interceptor chain

getInInterceptors

public List<Interceptor<? extends Message>> getInInterceptors()

Description copied from interface: InterceptorProvider

Returns the list of interceptors attached to the incoming interceptor chain of the object.

Specified by:

getInInterceptors in interface InterceptorProvider

Returns:

List incoming interceptor chain

getOutInterceptors

public List<Interceptor<? extends Message>> getOutInterceptors()

Description copied from interface: InterceptorProvider

Returns the list of interceptors attached to the outgoing interceptor chain of the object.

Specified by:

getOutInterceptors in interface InterceptorProvider

Returns:

List outgoing interceptor chain

setInInterceptors

public void setInInterceptors(List<Interceptor<? extends Message>> interceptors)

setInFaultInterceptors

public void setInFaultInterceptors(List<Interceptor<? extends Message>> interceptors)

setOutInterceptors

public void setOutInterceptors(List<Interceptor<? extends Message>> interceptors)

setOutFaultInterceptors

public void setOutFaultInterceptors(List<Interceptor<? extends Message>> interceptors)

setFeatures

public void setFeatures(List<AbstractFeature> f)

getFeatures

public List<AbstractFeature> getFeatures()