Package com.sun.identity.liberty.ws.disco

Class ResourceOffering

java.lang.Object

com.sun.identity.liberty.ws.disco.ResourceOffering

public class ResourceOffering
extends Object

The class ResourceOffering associates a resource with a service instance that provides access to that resource.

The following schema fragment specifies the expected content within the ResourceOffering object.

 <complexType name="ResourceOfferingType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{urn:liberty:disco:2003-08}ResourceIDGroup"/>
         <element name="ServiceInstance" type="{urn:liberty:disco:2003-08}ServiceInstanceType"/>
         <element ref="{urn:liberty:disco:2003-08}Options" minOccurs="0"/>
         <element name="Abstract" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
       <attribute name="entryID" type="{urn:liberty:disco:2003-08}IDType" />
     </restriction>
   </complexContent>
 </complexType>
 

An example of the ResourceOffering is :

 <ResourceOffering xmlns="urn:liberty:disco:2003-08">
     <ResourceID>http://profile-provider.com/profiles/l4m0B82k15csaUxs</ResourceID>
     <ServiceInstance xmlns="urn:liberty:disco:2003-08">
         <ServiceType>urn:liberty:idpp:2003-08</ServiceType>
         <ProviderID>http://profile-provider.com/</ProviderID>
         <Description>
             <SecurityMechID>urn:liberty:disco:2003-08:anonymous</SecurityMechID>
             <SecurityMechID>urn:liberty:security:2003-08:x509</SecurityMechID>
             <SecurityMechID>urn:liberty:security:2003-08:saml</SecurityMechID>
             <Endpoint>https://soap.profile-provider.com/soap/</Endpoint>
         </Description>
         <Description>
             <SecurityMechID>urn:ietf:rfc:2246</SecurityMechID>
             <Endpoint>https://soap-auth.profile-provider.com/soap/</Endpoint>
         </Description>
      </ServiceInstance>
      <Options>
          <Option>urn:liberty:idpp</Option>
          <Option>urn:liberty:idpp:cn</Option>
          <Option>urn:liberty:idpp:can</Option>
          <Option>urn:liberty:idpp:can:cn</Option>
      </Options>
      <Abstract>
          This is a personal profile containing common name information. 
      </Abstract>
 </ResourceOffering>
 

Constructor Summary

Constructors

Constructor	Description
ResourceOffering(EncryptedResourceID resourceID, ServiceInstance serviceInstance)	Constructor.
ResourceOffering(ResourceID resourceID, ServiceInstance serviceInstance)	Constructor.
ResourceOffering(Element elem)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getAbstract()	Gets abstract of the resource offering
EncryptedResourceID	getEncryptedResourceID()	Gets encrypted resource ID.
String	getEntryID()	Gets entry ID.
List	getOptions()	Gets options of the resource offering, which expresses the options available for the resource offering, that is provides hints to a potential requester whether certain data or operations may be available with a particular resource offering.
ResourceID	getResourceID()	Gets resource ID.
ServiceInstance	getServiceInstance()	Gets service instance.
void	setAbstract(String value)	Sets abstract.
void	setEncryptedResourceID(EncryptedResourceID resourceID)	Sets encrypted resource ID.
void	setEntryID(String value)	Sets entry ID.
void	setOptions(List options)	Sets options.
void	setResourceID(ResourceID resourceID)	Sets resource ID.
void	setServiceInstance(ServiceInstance value)	Sets service instance.
String	toString()	Returns string representation of object ResourceOffering.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceOffering

public ResourceOffering(ResourceID resourceID,
                        ServiceInstance serviceInstance)

Constructor.

Parameters:

resourceID - ID for the resource.

serviceInstance - service instance.

ResourceOffering

public ResourceOffering(EncryptedResourceID resourceID,
                        ServiceInstance serviceInstance)

Constructor.

Parameters:

resourceID - Encrypted Resource ID.

serviceInstance - service instance.

ResourceOffering

public ResourceOffering(Element elem)
                 throws DiscoveryException

Constructor.

Parameters:

elem - ResourceOffering DOM element.

Throws:

DiscoveryException - if error occurs.

Method Detail

getOptions

public List getOptions()

Gets options of the resource offering, which expresses the options available for the resource offering, that is provides hints to a potential requester whether certain data or operations may be available with a particular resource offering.

Returns:

List of options as String

See Also:

setOptions(List)

setOptions

public void setOptions(List options)

Sets options.

Parameters:

options - List of options as String

See Also:

getOptions()

getEncryptedResourceID

public EncryptedResourceID getEncryptedResourceID()

Gets encrypted resource ID.

Returns:

encrypted resource ID.

See Also:

setEncryptedResourceID(EncryptedResourceID)

setEncryptedResourceID

public void setEncryptedResourceID(EncryptedResourceID resourceID)

Sets encrypted resource ID.

Parameters:

resourceID - EncryptedResourceID to be set

See Also:

getEncryptedResourceID()

getResourceID

public ResourceID getResourceID()

Gets resource ID.

Returns:

resource ID.

See Also:

setResourceID(ResourceID)

setResourceID

public void setResourceID(ResourceID resourceID)

Sets resource ID.

Parameters:

resourceID - resource ID.

See Also:

getResourceID()

getEntryID

public String getEntryID()

Gets entry ID.

Returns:

entry ID.

See Also:

setEntryID(String)

setEntryID

public void setEntryID(String value)

Sets entry ID.

Parameters:

value - of the id

See Also:

getEntryID()

getServiceInstance

public ServiceInstance getServiceInstance()

Gets service instance.

Returns:

service instance.

See Also:

setServiceInstance(ServiceInstance)

setServiceInstance

public void setServiceInstance(ServiceInstance value)

Sets service instance.

Parameters:

value - service instance.

See Also:

getServiceInstance()

getAbstract

public String getAbstract()

Gets abstract of the resource offering

Returns:

abstract of the resource offering.

See Also:

setAbstract(String)

setAbstract

public void setAbstract(String value)

Sets abstract.

Parameters:

value - abstract of the resource offering.

See Also:

getAbstract()

toString

public String toString()

Returns string representation of object ResourceOffering.

Overrides:

toString in class Object

Returns:

string representation