a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: ResourceOffering.java,v 1.2 2008/06/25 05:47:11 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.liberty.ws.disco.common.DiscoConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.liberty.ws.disco.common.DiscoUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The class <code>ResourceOffering</code> associates a resource with a service
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * instance that provides access to that resource.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <p>The following schema fragment specifies the expected content within the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>ResourceOffering</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <complexType name="ResourceOfferingType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <group ref="{urn:liberty:disco:2003-08}ResourceIDGroup"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element name="ServiceInstance" type="{urn:liberty:disco:2003-08}ServiceInstanceType"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element ref="{urn:liberty:disco:2003-08}Options" minOccurs="0"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element name="Abstract" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <attribute name="entryID" type="{urn:liberty:disco:2003-08}IDType" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </restriction>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * An example of the <code>ResourceOffering</code> is :
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <ResourceOffering xmlns="urn:liberty:disco:2003-08">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <ResourceID>http://profile-provider.com/profiles/l4m0B82k15csaUxs</ResourceID>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <ServiceInstance xmlns="urn:liberty:disco:2003-08">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <ServiceType>urn:liberty:idpp:2003-08</ServiceType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <ProviderID>http://profile-provider.com/</ProviderID>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <Description>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <SecurityMechID>urn:liberty:disco:2003-08:anonymous</SecurityMechID>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <SecurityMechID>urn:liberty:security:2003-08:x509</SecurityMechID>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <SecurityMechID>urn:liberty:security:2003-08:saml</SecurityMechID>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <Endpoint>https://soap.profile-provider.com/soap/</Endpoint>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </Description>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <Description>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <SecurityMechID>urn:ietf:rfc:2246</SecurityMechID>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <Endpoint>https://soap-auth.profile-provider.com/soap/</Endpoint>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </Description>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </ServiceInstance>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <Options>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <Option>urn:liberty:idpp</Option>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <Option>urn:liberty:idpp:cn</Option>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <Option>urn:liberty:idpp:can</Option>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <Option>urn:liberty:idpp:can:cn</Option>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </Options>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <Abstract>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This is a personal profile containing common name information.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </Abstract>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </ResourceOffering>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private EncryptedResourceID encryptResID = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private ServiceInstance serviceInstance = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructor.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param resourceID ID for the resource.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param serviceInstance service instance.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public ResourceOffering (ResourceID resourceID,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructor.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param resourceID Encrypted Resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param serviceInstance service instance.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public ResourceOffering (EncryptedResourceID resourceID,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructor.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param elem <code>ResourceOffering</code> DOM element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception DiscoveryException if error occurs.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public ResourceOffering(Element elem) throws DiscoveryException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.message("ResourceOffering(Element): null input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (((nodeName = elem.getLocalName()) == null) ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster ((nameSpaceURI = elem.getNamespaceURI()) == null) ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster (!nameSpaceURI.equals(DiscoConstants.DISCO_NS)))
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.message("ResourceOffering(Element): wrong input");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster for (int i = 0, length = contentnl.getLength(); i < length; i++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((nodeName = child.getLocalName()) != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster nameSpaceURI = ((Element) child).getNamespaceURI();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster (!nameSpaceURI.equals(DiscoConstants.DISCO_NS)))
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.message("ResourceOffering(Element): "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((resourceID != null) || (encryptResID != null)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.message("ResourceOffering(Element)"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + ": Included more than one ResourceIDGroup "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "element.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.bundle.getString("moreResourceIDGroup"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.error("ResourceOffering(Element):",de);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } else if (nodeName.equals("EncryptedResourceID")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((resourceID != null) || (encryptResID != null)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.message("ResourceOffering(Element)"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + ": Included more than one ResourceIDGroup "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "element.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.bundle.getString("moreResourceIDGroup"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster encryptResID = new EncryptedResourceID((Element) child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } else if (nodeName.equals("ServiceInstance")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.message("ResourceOffering(Element)"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + ": Included more than one ServiceInstance.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster serviceInstance = new ServiceInstance((Element) child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.message("ResourceOffering(Element)"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + ": Included more than one Options.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster options = DiscoUtils.parseOptions((Element) child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.message("ResourceOffering(Element)"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + ": Included more than one Abstract.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster abs = XMLUtils.getElementValue((Element) child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.message("ResourceOffering(Element): "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((resourceID == null) && (encryptResID == null)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (DiscoUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.message("ResourceOffering(Element): missing "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "ResourceID or EncryptedResourceID element.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new DiscoveryException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.bundle.getString("missingResourceIDGroup"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (serviceInstance == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (DiscoUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.debug.message("ResourceOffering(Element): missing "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "ServiceInstance element.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new DiscoveryException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DiscoUtils.bundle.getString("missingServiceInstance"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets options of the resource offering, which expresses the options
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * available for the resource offering, that is provides hints to a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * potential requester whether certain data or operations may be available
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with a particular resource offering.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return List of options as String
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setOptions(List)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets options.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param options List of options as String
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getOptions()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets encrypted resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return encrypted resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setEncryptedResourceID(EncryptedResourceID)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public EncryptedResourceID getEncryptedResourceID() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets encrypted resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param resourceID <code>EncryptedResourceID</code> to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getEncryptedResourceID()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setEncryptedResourceID(EncryptedResourceID resourceID) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setResourceID(ResourceID)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param resourceID resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getResourceID()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setResourceID(ResourceID resourceID) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets entry ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return entry ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setEntryID(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets entry ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value of the id
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getEntryID()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets service instance.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return service instance.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setServiceInstance(ServiceInstance)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets service instance.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value service instance.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getServiceInstance()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setServiceInstance(ServiceInstance value) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets abstract of the resource offering
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return abstract of the resource offering.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setAbstract(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets abstract.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value abstract of the resource offering.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getAbstract()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns string representation of object <code>ResourceOffering</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return string representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // entryID, resIDgroup, service instance, options, Abstract
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append("<ResourceOffering xmlns=\"").append(DiscoConstants.DISCO_NS).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((entryID != null) && entryID.length() != 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append(" entryID=\"").append(entryID).append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((option != null) && option.length() != 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append("<Abstract>").append(abs).append("</Abstract>");