BindingClientPartner (BEA WebLogic Server 10.3 Tech Preview API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

BEA Systems, Inc.

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

All Superinterfaces:: Partner, Serializable

All Known Subinterfaces:: WebSSOIdPPartner, WebSSOPartner, WebSSOSPPartner

All Known Implementing Classes:: WebSSOIdPPartnerImpl, WebSSOSPPartnerImpl

public interface BindingClientPartner
extends Partner
extends Partner

BindingClientPartner is the partner that supports backend channel communication. This class contains some information to authenticate against the peer, including transporting layer certificates for 2-way SSL, 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()` Returns encrypted client binding password, if available
`String`	`getClientUsername()` Get the binding client username.
`X509Certificate`	`getTransportLayerClientCert()` Get the transport level security (TLS/SSL) client certificate.
`boolean`	`isClientPasswordSet()` Check whether the ClientPassword is set
`void`	`setClientPassword(String password)` Set the password that must be used by this partner when access bindings of the local site, e.g.
`void`	`setClientUsername(String username)` Set the binding client username.
`void`	`setTransportLayerClientCert(X509Certificate clientCert)` Set the transport layer security (TLS/SSL) client 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()

Get the transport level security (TLS/SSL) client certificate. This is the certificate that must be used by this partner when connecting to bindings of the local site, e.g. SOAP/HTTPS binding, using SSL/TLS.

Returns:: The transport level security (SSL/TLS) client certificate.

setTransportLayerClientCert

void setTransportLayerClientCert(X509Certificate clientCert)

Set the transport layer security (TLS/SSL) client certificate.

Parameters:: clientCert - The client certificate
See Also:: BindingClientPartner.getTransportLayerClientCert()

getClientUsername

String getClientUsername()

Get the binding client username. This is the username that must be used by this partner when connecting to bindings of the local site, e.g. SOAP/HTTPS binding.

Returns:: The binding client username.

setClientUsername

void setClientUsername(String username)

Set the binding client username.

Parameters:: username - The binding client username
See Also:: BindingClientPartner.getClientUsername()

getClientPasswordEncrypted

String getClientPasswordEncrypted()

Returns encrypted client binding password, if available

Returns:: the encrypted ClientPassword if the ClientPassword is set and the encrypted value is available

isClientPasswordSet

boolean isClientPasswordSet()

Check whether the ClientPassword is set

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

setClientPassword

void setClientPassword(String password)

Set the password that must be used by this partner when access bindings of the local site, e.g. SOAP/HTTS binding

Parameters:: password - The client binding password to set.