Oracle

com.bea.security.saml2.providers.registry
Interface BindingClientPartner

All Superinterfaces:
Partner, Serializable
All Known Subinterfaces:
WebSSOIdPPartner, WebSSOPartner, WebSSOSPPartner

public interface BindingClientPartner
extends Partner

Binding Client partner is a partner that supports backend channel communication. This class specifies the expected authentication to SOAP/HTTPS bindings of the local site, including transporting layer certificates for 2-way SSL, and username/password for Basic authentication.


Field Summary
 
Fields inherited from interface com.bea.security.saml2.providers.registry.Partner
ASSERTION_TYPE_BEARER, ASSERTION_TYPE_HOLDER_OF_KEY, ASSERTION_TYPE_SENDER_VOUCHES
 
Method Summary
 String getClientPasswordEncrypted()
          Gets the encrypted password for Basic authentication if available.
 String getClientUsername()
          Gets the username used by this partner for Basic authentication when connecting to the SOAP/HTTPS binding of the local site.
 X509Certificate getTransportLayerClientCert()
          Gets the transport level security (SSL/TLS) certificate that must be used by this partner for 2-way SSL when connecting to the SOAP/HTTPS binding of the local site.
 boolean isClientPasswordSet()
          Gets the flag that indicates if the password for Basic authentication is set.
 void setClientPassword(String password)
          Sets the password that must be used by this partner for Basic authentication when connecting to the SOAP/HTTPS binding of the local site.
 void setClientUsername(String username)
          Sets the username for Basic authentication.
 void setTransportLayerClientCert(X509Certificate clientCert)
          Sets the transport layer security (SSL/TLS) certificate.
 
Methods inherited from interface com.bea.security.saml2.providers.registry.Partner
getAudienceURIs, getDescription, getName, isEnabled, isNameModified, setAudienceURIs, setDescription, setEnabled, setName
 

Method Detail

getTransportLayerClientCert

X509Certificate getTransportLayerClientCert()
Gets the transport level security (SSL/TLS) certificate that must be used by this partner for 2-way SSL when connecting to the SOAP/HTTPS binding of the local site.

Returns:
the transport level security (SSL/TLS) certificate

setTransportLayerClientCert

void setTransportLayerClientCert(X509Certificate clientCert)
Sets the transport layer security (SSL/TLS) certificate.

Parameters:
clientCert - the certificate to set
See Also:
BindingClientPartner.getTransportLayerClientCert()

getClientUsername

String getClientUsername()
Gets the username used by this partner for Basic authentication when connecting to the SOAP/HTTPS binding of the local site.

Returns:
the username for Basic authentication

setClientUsername

void setClientUsername(String username)
Sets the username for Basic authentication.

Parameters:
username - the username to set for Basic authentication
See Also:
BindingClientPartner.getClientUsername()

getClientPasswordEncrypted

String getClientPasswordEncrypted()
Gets the encrypted password for Basic authentication if available.

Returns:
the encrypted password if the password is set and the encrypted value is available
See Also:
BindingClientPartner.setClientPassword(String), BindingClientPartner.isClientPasswordSet()

isClientPasswordSet

boolean isClientPasswordSet()
Gets the flag that indicates if the password for Basic authentication is set.

Returns:
true if the password is set (not 'null' and not empty string)
See Also:
BindingClientPartner.setClientPassword(String)

setClientPassword

void setClientPassword(String password)
Sets the password that must be used by this partner for Basic authentication when connecting to the SOAP/HTTPS binding of the local site.

Parameters:
password - the password to set for Basic authentication

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs103
Copyright 1996,2008, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.