| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--com.sun.identity.liberty.ws.disco.ResourceOffering
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 | |
| ResourceOffering(org.w3c.dom.Element elem)Constructor. | |
| ResourceOffering(EncryptedResourceID resourceID,
                 ServiceInstance serviceInstance)Constructor. | |
| ResourceOffering(ResourceID resourceID,
                 ServiceInstance serviceInstance)Constructor. | |
| Method Summary | |
|  java.lang.String | getAbstract()Gets abstract of the resource offering | 
|  EncryptedResourceID | getEncryptedResourceID()Gets encrypted resource ID. | 
|  java.lang.String | getEntryID()Gets entry ID. | 
|  java.util.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(java.lang.String value)Sets abstract. | 
|  void | setEncryptedResourceID(EncryptedResourceID resourceID)Sets encrypted resource ID. | 
|  void | setEntryID(java.lang.String value)Sets entry ID | 
|  void | setOptions(java.util.List options)Sets options | 
|  void | setResourceID(ResourceID resourceID)Sets resource ID. | 
|  void | setServiceInstance(ServiceInstance value)Sets service instance. | 
|  java.lang.String | toString()Returns string representation | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Constructor Detail | 
public ResourceOffering(ResourceID resourceID,
                        ServiceInstance serviceInstance)
resourceID - ID for the resource.serviceInstance - service instance.
public ResourceOffering(EncryptedResourceID resourceID,
                        ServiceInstance serviceInstance)
resourceID - Encrypted Resource ID.serviceInstance - service instance.
public ResourceOffering(org.w3c.dom.Element elem)
                 throws DiscoveryException
elem - ResourceOffering DOM element.DiscoveryException - if error occurs.| Method Detail | 
public java.util.List getOptions()
public void setOptions(java.util.List options)
options - List of options as Stringpublic EncryptedResourceID getEncryptedResourceID()
public void setEncryptedResourceID(EncryptedResourceID resourceID)
resourceID - EncryptedResourceID to be setpublic ResourceID getResourceID()
public void setResourceID(ResourceID resourceID)
resourceID - resource ID.public java.lang.String getEntryID()
public void setEntryID(java.lang.String value)
value - allowed object is
 Stringpublic ServiceInstance getServiceInstance()
public void setServiceInstance(ServiceInstance value)
value - service instance.public java.lang.String getAbstract()
public void setAbstract(java.lang.String value)
value - abstract of the resource offering.public java.lang.String toString()
toString in class java.lang.Object| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||