oracle.security.xmlsec.liberty.v11

Class ProviderDescriptor

java.lang.Object

oracle.security.xmlsec.util.XMLNode

oracle.security.xmlsec.util.XMLElement

oracle.security.xmlsec.liberty.v11.ProviderDescriptor

Direct Known Subclasses:

IDPDescriptor, SPDescriptor

public abstract class ProviderDescriptor
extends XMLElement

This abstract class contains provider metadata that are generic to both the service provider and the identity provider.

Field Summary

Fields inherited from class oracle.security.xmlsec.util.XMLNode

node, systemId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProviderDescriptor(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String localName) Creates a new ProviderDescriptor instance.
protected	ProviderDescriptor(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String localName, java.lang.String providerId) Creates a new ProviderDescriptor instance.
protected	ProviderDescriptor(org.w3c.dom.Element element) Creates a new ProviderDescriptor instance from the given Element node.
protected	ProviderDescriptor(org.w3c.dom.Element element, java.lang.String systemId) Creates a new ProviderDescriptor instance from the given Element node.

Method Summary

Modifier and Type	Method and Description
void	addFederationTerminationNotificationProtocolProfile(java.lang.String fedTermProfURI) Adds an FederationTerminationNotificationProtocolProfile element to this structure.
void	addRegisterNameIdentifierProtocolProfile(java.lang.String regNameProfURI) Adds an RegisterNameIdentifierProtocolProfile element to this structure.
void	addSingleLogoutProtocolProfile(java.lang.String logoutProfURI) Adds an SingleLogoutProtocolProfile element to this structure.
java.util.List	getFederationTerminationNotificationProtocolProfiles() Returns a list of URIs identifying the Federation Termination Notification Protocol Profiles supported by the provider as specified in the FederationTerminationNotificationProtocolProfile elements in this structure.
java.lang.String	getFederationTerminationServiceReturnURL() Returns the provider's federation termination service return URI specified in the FederationTerminationServiceReturnURL child element in this structure.
java.lang.String	getFederationTerminationServiceURL() Returns the provider's federation termination service URI specified in the FederationTerminationServiceURL child element in this structure.
XSKeyInfo	getKeyInfo() Gets the KeyInfo element contained in this element.
java.lang.String	getProviderID() Returns the provider's URI-based ideitifier contained in the ProviderID child element in this structure.
java.util.List	getRegisterNameIdentifierProtocolProfiles() Returns a list of URIs identifying the Single Logout Protocol Profiles supported by the provider as specified in the RegisterNameIdentifierProtocolProfile elements in this structure.
java.lang.String	getRegisterNameIdentifierServiceReturnURL() Returns the provider's register name identifier service return URI specified in the RegisterNameIdentifierServiceReturnURL child element in this structure.
java.lang.String	getRegisterNameIdentifierServiceURL() Returns the provider's register name identifier service URI specified in the RegisterNameIdentifierServiceURL child element in this structure.
java.util.List	getSingleLogoutProtocolProfiles() Returns a list of URIs identifying the Single Logout Protocol Profiles supported by the provider as specified in the SingleLogoutProtocolProfile elements in this structure.
java.lang.String	getSingleLogoutServiceReturnURL() Returns the provider's single logout service return URI specified in the SingleLogoutServiceReturnURL child element in this structure.
java.lang.String	getSingleLogoutServiceURL() Returns the provider's single logout service URI specified in the SingleLogoutServiceURL child element in this structure.
java.lang.String	getSoapEndpoint() Returns the provider's SOAP endpoint URI contained in the SoapEndpoint child element in this structure.
void	setFederationTerminationServiceReturnURL(java.lang.String fedTermReturnURI) Sets the FederationTerminationServiceReturnURL child element in this structure.
void	setFederationTerminationServiceURL(java.lang.String fedTermServiceURI) Set the FederationTerminationServiceURL child element in this structure.
void	setKeyInfo(XSKeyInfo keyInfo) Sets the ds:KeyInfo child element of this element.
void	setProviderID(java.lang.String providerID) Sets the ProviderID child element in this provider descriptor.
void	setRegisterNameIdentifierServiceReturnURL(java.lang.String regNameReturnURI) Set the RegisterNameIdentifierServiceReturnURL child element in this structure.
void	setRegisterNameIdentifierServiceURL(java.lang.String regNameServiceURI) Set the RegisterNameIdentifierServiceURL child element in this structure.
void	setSingleLogoutServiceReturnURL(java.lang.String logoutReturnURI) Set the SingleLogoutServiceReturnURL child element in this structure.
void	setSingleLogoutServiceURL(java.lang.String logoutServiceURI) Set the SingleLogoutServiceURL child element in this structure.
void	setSoapEndpoint(java.lang.String soapEndpointURI) Set the SoapEndpoint child element in this structure.

Methods inherited from class oracle.security.xmlsec.util.XMLElement

addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, getElement, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setDefaultNSPrefix

Methods inherited from class oracle.security.xmlsec.util.XMLNode

appendChild, appendChild, appendTo, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getSystemId, hasAttributes, hasChildNodes, insertBefore, insertBefore, isSupported, normalize, removeChild, removeChild, replaceChild, replaceChild, setNodeValue, setPrefix, setSystemId, toBytesXML, toStringXML

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderDescriptor

protected ProviderDescriptor(org.w3c.dom.Element element)
                      throws org.w3c.dom.DOMException

Creates a new ProviderDescriptor instance from the given Element node.

Parameters:

element - A Liberty ProviderDescriptor XML element.

Throws:

org.w3c.dom.DOMException

ProviderDescriptor

protected ProviderDescriptor(org.w3c.dom.Element element,
                             java.lang.String systemId)
                      throws org.w3c.dom.DOMException

Creates a new ProviderDescriptor instance from the given Element node.

Parameters:

element - A Liberty ProviderDescriptor XML element.

systemId - The URI string system ID for the ProviderDescriptor.

Throws:

org.w3c.dom.DOMException

ProviderDescriptor

protected ProviderDescriptor(org.w3c.dom.Document owner,
                             java.lang.String nsURI,
                             java.lang.String localName)
                      throws org.w3c.dom.DOMException

Creates a new ProviderDescriptor instance.

Parameters:

owner - The owner document of the new ProviderDescriptor.

nsURI - The namespace URI in which the new ProviderDescriptor is to be created.

localName - The localName of the element represented by the class that extends this abstract class.

Throws:

org.w3c.dom.DOMException

ProviderDescriptor

protected ProviderDescriptor(org.w3c.dom.Document owner,
                             java.lang.String nsURI,
                             java.lang.String localName,
                             java.lang.String providerId)
                      throws org.w3c.dom.DOMException

Creates a new ProviderDescriptor instance.

Parameters:

owner - The owner document of the new ProviderDescriptor.

nsURI - The namespace URI in which the new ProviderDescriptor is to be created.

localName - The localName of the element represented by the class that extends this abstract class.

providerId - The lib:ProviderID child element.

Throws:

org.w3c.dom.DOMException

Method Detail

setProviderID

public void setProviderID(java.lang.String providerID)

Sets the ProviderID child element in this provider descriptor. This required child contains the provider's URI-based identifier.

Parameters:

providerID - The URI-based identifier of the provider.

getProviderID

public java.lang.String getProviderID()

Returns the provider's URI-based ideitifier contained in the ProviderID child element in this structure.

setKeyInfo

public void setKeyInfo(XSKeyInfo keyInfo)

Sets the ds:KeyInfo child element of this element. This optional child element contains the information on the provider's public key.

getKeyInfo

public XSKeyInfo getKeyInfo()

Gets the KeyInfo element contained in this element.

Returns:

An XSKeyInfo object or null if not set.

setSoapEndpoint

public void setSoapEndpoint(java.lang.String soapEndpointURI)

Set the SoapEndpoint child element in this structure. This optional child element contains the provider's SOAP endpoint URI.

Parameters:

soapEndpointURI - The provider's SOAP endpoint URI.

getSoapEndpoint

public java.lang.String getSoapEndpoint()

Returns the provider's SOAP endpoint URI contained in the SoapEndpoint child element in this structure.

Returns:

The provider's SOAP endpoint URI specified in the SoapEndpoint element or null if not set.

setSingleLogoutServiceURL

public void setSingleLogoutServiceURL(java.lang.String logoutServiceURI)

Set the SingleLogoutServiceURL child element in this structure. This optional child element contains the URL at the service provider or the identity provider to which single logout requests are sent.

Parameters:

logoutServiceURI - The provider's single logout service URI.

getSingleLogoutServiceURL

public java.lang.String getSingleLogoutServiceURL()

Returns the provider's single logout service URI specified in the SingleLogoutServiceURL child element in this structure.

Returns:

The provider's single logout service URI or null if not set.

setSingleLogoutServiceReturnURL

public void setSingleLogoutServiceReturnURL(java.lang.String logoutReturnURI)

Set the SingleLogoutServiceReturnURL child element in this structure. This optional child element contains the URL to which the provider redirect at the end of user-agent-based Single Logout Protocol Profiles..

Parameters:

logoutReturnURI - The provider's single logout service return URI.

getSingleLogoutServiceReturnURL

public java.lang.String getSingleLogoutServiceReturnURL()

Returns the provider's single logout service return URI specified in the SingleLogoutServiceReturnURL child element in this structure.

Returns:

The provider's single logout service return URI or null if not set.

setFederationTerminationServiceURL

public void setFederationTerminationServiceURL(java.lang.String fedTermServiceURI)

Set the FederationTerminationServiceURL child element in this structure. This optional child element contains the URL at the service provider or the identity provider to which federation termination notifications are sent.

Parameters:

fedTermServiceURI - The provider's federation termination service URI.

getFederationTerminationServiceURL

public java.lang.String getFederationTerminationServiceURL()

Returns the provider's federation termination service URI specified in the FederationTerminationServiceURL child element in this structure.

Returns:

The provider's federation termination service URI or null if not set.

setFederationTerminationServiceReturnURL

public void setFederationTerminationServiceReturnURL(java.lang.String fedTermReturnURI)

Sets the FederationTerminationServiceReturnURL child element in this structure. This optional child element contains the URL used by the service provider or the identity provider when redirecting the user-agent at the end of the federation termination notification profile process.

Parameters:

fedReturnURI - The provider's federation termination return URI.

getFederationTerminationServiceReturnURL

public java.lang.String getFederationTerminationServiceReturnURL()

Returns the provider's federation termination service return URI specified in the FederationTerminationServiceReturnURL child element in this structure.

Returns:

The provider's federation termination service return URI or null if not set.

addFederationTerminationNotificationProtocolProfile

public void addFederationTerminationNotificationProtocolProfile(java.lang.String fedTermProfURI)

Adds an FederationTerminationNotificationProtocolProfile element to this structure.

Parameters:

fedTermProfURI - An URI identifying a Federation Termination Notification Protocol Profile supported by the provider.

getFederationTerminationNotificationProtocolProfiles

public java.util.List getFederationTerminationNotificationProtocolProfiles()

Returns a list of URIs identifying the Federation Termination Notification Protocol Profiles supported by the provider as specified in the FederationTerminationNotificationProtocolProfile elements in this structure.

Returns:

A List object containing String objects, or an empty List if no FederationTerminationNotificationProtocolProfile element has been set.

addSingleLogoutProtocolProfile

public void addSingleLogoutProtocolProfile(java.lang.String logoutProfURI)

Adds an SingleLogoutProtocolProfile element to this structure.

Parameters:

logoutProfURI - An URI identifying a Single Logout Protocol Profile supported by the provider.

getSingleLogoutProtocolProfiles

public java.util.List getSingleLogoutProtocolProfiles()

Returns a list of URIs identifying the Single Logout Protocol Profiles supported by the provider as specified in the SingleLogoutProtocolProfile elements in this structure.

Returns:

A List object containing String objects, or an empty List if no SingleLogoutProtocolProfile element has been set.

addRegisterNameIdentifierProtocolProfile

public void addRegisterNameIdentifierProtocolProfile(java.lang.String regNameProfURI)

Adds an RegisterNameIdentifierProtocolProfile element to this structure.

Parameters:

regNameProfURI - A URI identifying a Register Name Identifier Protocol Profile supported by the provider.

getRegisterNameIdentifierProtocolProfiles

public java.util.List getRegisterNameIdentifierProtocolProfiles()

Returns a list of URIs identifying the Single Logout Protocol Profiles supported by the provider as specified in the RegisterNameIdentifierProtocolProfile elements in this structure.

Returns:

A List object containing String objects, or an empty List if no RegisterNameIdentifierProtocolProfile element has been set.

setRegisterNameIdentifierServiceURL

public void setRegisterNameIdentifierServiceURL(java.lang.String regNameServiceURI)

Set the RegisterNameIdentifierServiceURL child element in this structure. This optional child element contains the URL at the service provider or the identity provider to which register name identifier requests are sent.

Parameters:

regNameServiceURI - The provider's register name identifier service URI.

getRegisterNameIdentifierServiceURL

public java.lang.String getRegisterNameIdentifierServiceURL()

Returns the provider's register name identifier service URI specified in the RegisterNameIdentifierServiceURL child element in this structure.

Returns:

The provider's register name identifier service URI or null if not set.

setRegisterNameIdentifierServiceReturnURL

public void setRegisterNameIdentifierServiceReturnURL(java.lang.String regNameReturnURI)

Set the RegisterNameIdentifierServiceReturnURL child element in this structure. This optional child element contains the URL to which the provider redirect at the end of user-agent-based Register Name Identifier Protocol Profiles..

Parameters:

regNameReturnURI - The provider's register name identifier service return URI.

getRegisterNameIdentifierServiceReturnURL

public java.lang.String getRegisterNameIdentifierServiceReturnURL()

Returns the provider's register name identifier service return URI specified in the RegisterNameIdentifierServiceReturnURL child element in this structure.

Returns:

The provider's register name identifier service return URI or null if not set.