Oracle Fusion Middleware
Oracle WebLogic Server API Reference
12c Release 1 (12.1.1)

Part Number E24391-02

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

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

public interface MetadataPartner
extends Partner

Metadata partner contains contact information for the partner, which is mainly required by the SAML 2.0 metadata profile.


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 getContactPersonCompany()
          Returns the company name of the contact person.
 String getContactPersonEmailAddress()
          Returns the email address of the contact person.
 String getContactPersonGivenName()
          Returns the given name of the contact person.
 String getContactPersonSurName()
          Returns the surname of the contact person.
 String getContactPersonTelephoneNumber()
          Returns the telephone number of the contact person.
 String getContactPersonType()
          Returns the type of the contact person.
 String getEntityID()
          Returns this partner's entity ID, which must be a URI.
 String getErrorURL()
          Returns the URI that specifies a location to direct a user for problem resolution and additional support.
 String getOrganizationName()
          Returns the organization name.
 String getOrganizationURL()
          Returns the organization URL.
 void setContactPersonCompany(String company)
          Sets the company name of the contact person.
 void setContactPersonEmailAddress(String address)
          Sets the email address of the contact person.
 void setContactPersonGivenName(String name)
          Sets the given name of the contact person.
 void setContactPersonSurName(String name)
          Sets the surname of the contact person.
 void setContactPersonTelephoneNumber(String number)
          Sets the telephone number of the contact person.
 void setContactPersonType(String type)
          Sets the type of the contact person.
 void setEntityID(String entityID)
          Sets the entity ID for this partner.
 void setErrorURL(String url)
          Sets the error URL.
 void setOrganizationName(String name)
          Sets the organization name.
 void setOrganizationURL(String url)
          Sets the organization URL.
 
Methods inherited from interface com.bea.security.saml2.providers.registry.Partner
getAudienceURIs, getDescription, getName, isEnabled, isNameModified, setAudienceURIs, setDescription, setEnabled, setName
 

Method Detail

getEntityID

String getEntityID()
Returns this partner's entity ID, which must be a URI. This value is the expected <Issuer> value for documents from this partner and the default value for <Audience> for documents sent to this partner.

Returns:
the entity ID of this partner

setEntityID

void setEntityID(String entityID)
Sets the entity ID for this partner.

Parameters:
entityID - the entity ID to set
See Also:
MetadataPartner.getEntityID()

getContactPersonGivenName

String getContactPersonGivenName()
Returns the given name of the contact person.

Returns:
the given name of the contact person

setContactPersonGivenName

void setContactPersonGivenName(String name)
Sets the given name of the contact person.

Parameters:
name - the given name of the contact person to set

getContactPersonSurName

String getContactPersonSurName()
Returns the surname of the contact person.

Returns:
the surname of the contact person

setContactPersonSurName

void setContactPersonSurName(String name)
Sets the surname of the contact person.

Parameters:
name - the surname of the contact person to set

getContactPersonType

String getContactPersonType()
Returns the type of the contact person.

Returns:
the type of the contact person

setContactPersonType

void setContactPersonType(String type)
Sets the type of the contact person.

Parameters:
type - the type of the contact person to set

getContactPersonCompany

String getContactPersonCompany()
Returns the company name of the contact person.

Returns:
the company name of the contact person

setContactPersonCompany

void setContactPersonCompany(String company)
Sets the company name of the contact person.

Parameters:
company - the company name of the contact person to set

getContactPersonTelephoneNumber

String getContactPersonTelephoneNumber()
Returns the telephone number of the contact person.

Returns:
the telephone number of the contact person

setContactPersonTelephoneNumber

void setContactPersonTelephoneNumber(String number)
Sets the telephone number of the contact person.

Parameters:
number - the telephone number of the contact person to set

getContactPersonEmailAddress

String getContactPersonEmailAddress()
Returns the email address of the contact person.

Returns:
the email address of the contact person

setContactPersonEmailAddress

void setContactPersonEmailAddress(String address)
Sets the email address of the contact person.

Parameters:
address - the email address of the contact person to set

getOrganizationName

String getOrganizationName()
Returns the organization name.

Returns:
the organization name

setOrganizationName

void setOrganizationName(String name)
Sets the organization name.

Parameters:
name - the organization name to set

getOrganizationURL

String getOrganizationURL()
Returns the organization URL.

Returns:
the organization URL

setOrganizationURL

void setOrganizationURL(String url)
Sets the organization URL.

Parameters:
url - the organization URL to set

getErrorURL

String getErrorURL()
Returns the URI that specifies a location to direct a user for problem resolution and additional support. The error URL is part of SAML 2.0 metadata, but is not actually used in the SAML2 implementation of CSS.

Returns:
the error url

setErrorURL

void setErrorURL(String url)
Sets the error URL.

Parameters:
url - the error URL to set
See Also:
MetadataPartner.getErrorURL()

Copyright 1996, 2011, 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.

Oracle Fusion Middleware
Oracle WebLogic Server API Reference
12c Release 1 (12.1.1)

Part Number E24391-02