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

void	cancelSecurityToken(SecurityToken token)
String	getBeanName() Get the configurable object's Bean name
List<AbstractFeature>	getFeatures()
List<Interceptor>	getInFaultInterceptors() Returns the list of interceptors attached to the incoming fault interceptor chain of the object.
List<Interceptor>	getInInterceptors() Returns the list of interceptors attached to the incoming interceptor chain of the object.
int	getKeySize()
List<Interceptor>	getOutFaultInterceptors() Returns the list of interceptors attached to the outgoing fault interceptor chain of the object.
List<Interceptor>	getOutInterceptors() Returns the list of interceptors attached to the outgoing interceptor chain of the object.
Map<String,Object>	getProperties()
Map<String,Object>	getRequestContext()
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	setEndpointName(String qn)
void	setEndpointQName(QName qn)
void	setFeatures(List<AbstractFeature> f)
void	setInFaultInterceptors(List<Interceptor> interceptors)
void	setInInterceptors(List<Interceptor> interceptors)
void	setKeySize(int i)
void	setLocation(String location)
void	setOutFaultInterceptors(List<Interceptor> interceptors)
void	setOutInterceptors(List<Interceptor> interceptors)
void	setPolicy(Element newPolicy) Deprecated. This method and its overloaded counterpart setPolicy(Policy) will be removed in future versions to facilitate configuration through inversion of control containers such as the Spring Framework. Use setPolicy(Object) instead.
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).
void	setPolicy(org.apache.neethi.Policy newPolicy) Deprecated. This method and its overloaded counterpart setPolicy(Element) will be removed in future versions to facilitate configuration through inversion of control containers such as the Spring Framework. Use setPolicy(Object) instead.
protected void	setPolicyInternal(Element newPolicy)
protected void	setPolicyInternal(org.apache.neethi.Policy newPolicy)
void	setPolicyObject(Object newPolicy) Deprecated. This method exists to allow the use of inversion of control containers such as the Spring Framework to configure an instance of this class while the overloaded and deprecated methods are still present. This method will be removed in future versions along with the previously existing deprecated methods.
void	setProperties(Map<String,Object> p)
void	setRequiresEntropy(boolean requiresEntropy)
void	setSecureConv(boolean secureConv)
void	setServiceName(String qn)
void	setServiceQName(QName qn)
void	setSoap11()
void	setSoap11(boolean b)
void	setSoap12()
void	setTemplate(Element rstTemplate)
void	setTrust(Trust10 trust)
void	setTrust(Trust13 trust)
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)
boolean	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)

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.

setPolicyObject

@Deprecated
public void setPolicyObject(Object newPolicy)

Deprecated. This method exists to allow the use of inversion of control containers such as the Spring Framework to configure an instance of this class while the overloaded and deprecated methods are still present. This method will be removed in future versions along with the previously existing deprecated methods.

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).

Parameters:

newPolicy - the policy object

See Also:

setPolicy(Object), setPolicy(Element), setPolicy(Policy)

setPolicy

@Deprecated
public void setPolicy(org.apache.neethi.Policy newPolicy)

Deprecated. This method and its overloaded counterpart setPolicy(Element) will be removed in future versions to facilitate configuration through inversion of control containers such as the Spring Framework. Use setPolicy(Object) instead.

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).

Parameters:

newPolicy - the policy object

setPolicy

public void setPolicy(Element newPolicy)

Deprecated. This method and its overloaded counterpart setPolicy(Policy) will be removed in future versions to facilitate configuration through inversion of control containers such as the Spring Framework. Use setPolicy(Object) instead.

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).

Parameters:

newPolicy - the policy DOM structure

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)

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)

setServiceName

public void setServiceName(String qn)

setEndpointName

public void setEndpointName(String qn)

setServiceQName

public void setServiceQName(QName qn)

setEndpointQName

public void setEndpointQName(QName qn)

setActAs

public void setActAs(Object actAs)

setKeySize

public void setKeySize(int i)

getKeySize

public int getKeySize()

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)

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

renewSecurityToken

public void renewSecurityToken(SecurityToken tok)
                        throws Exception

Throws:

Exception

validateSecurityToken

public boolean validateSecurityToken(SecurityToken tok)
                              throws Exception

Throws:

Exception

cancelSecurityToken

public void cancelSecurityToken(SecurityToken token)
                         throws Exception

Throws:

Exception

setTemplate

public void setTemplate(Element rstTemplate)

getOutFaultInterceptors

public List<Interceptor> 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> 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> 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> 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> interceptors)

setInFaultInterceptors

public void setInFaultInterceptors(List<Interceptor> interceptors)

setOutInterceptors

public void setOutInterceptors(List<Interceptor> interceptors)

setOutFaultInterceptors

public void setOutFaultInterceptors(List<Interceptor> interceptors)

setFeatures

public void setFeatures(List<AbstractFeature> f)

getFeatures

public List<AbstractFeature> getFeatures()