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: DSTQuery.java,v 1.3 2008/06/25 05:47:13 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.liberty.ws.disco.EncryptedResourceID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>DSTQuery</code> class represents a <code>DST</code> query request.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <p>The following schema fragment specifies the expected content within the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>DSTQuery</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <complexType name="QueryType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <group ref="{urn:liberty:idpp:2003-08}ResourceIDGroup"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element name="QueryItem" maxOccurs="unbounded">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <restriction base="{http://www.w3.org/2001/XMLSchema}
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element name="Select"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * type="{urn:liberty:idpp:2003-08}SelectType"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <attribute name="id"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * type="{http://www.w3.org/2001/XMLSchema}ID" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <attribute name="changedSince"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * type="{http://www.w3.org/2001/XMLSchema}dateTime" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <attribute name="itemID"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * type="{urn:liberty:idpp:2003-08}IDType" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <attribute name="includeCommonAttributes"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * type="{http://www.w3.org/2001/XMLSchema}boolean" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </restriction>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </element>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element ref="{urn:liberty:idpp:2003-08}Extension"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * maxOccurs="unbounded" minOccurs="0"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <attribute name="itemID" type="{urn:liberty:idpp:2003-08}IDType" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </restriction>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private EncryptedResourceID encryptedResourceID = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param resourceID id for the resource to be queried.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param items List of <code>DSTQueryItem</code> objects.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param serviceNS service name space.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public DSTQuery(String resourceID, java.util.List items, String serviceNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTQueryItem item = (DSTQueryItem)items.get(0);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param encResourceID id for the encrypted resource to be queried.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param items list of <code>DSTQueryItem</code> objects.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param serviceNS service name space.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public DSTQuery(com.sun.identity.liberty.ws.disco.EncryptedResourceID
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster encResourceID, java.util.List items, String serviceNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTQueryItem item = (DSTQueryItem)items.get(0);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param element <code>DOM</code> Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws DSTException
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public DSTQuery(org.w3c.dom.Element element) throws DSTException{
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTUtils.debug.error("DSTQuery(element):null input");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new DSTException(DSTUtils.bundle.getString("nullInputParams"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if(elementName == null || !elementName.equals("Query")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTUtils.debug.error("DSTQuery(element):Invalid element name");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new DSTException(DSTUtils.bundle.getString("invalidElement"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTUtils.debug.error("DSTModify(element): NameSpace is not defined");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new DSTException(DSTUtils.bundle.getString("noNameSpace"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster NodeList list = element.getElementsByTagNameNS(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if((list.getLength() == 0) || (list.getLength() > 1)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTUtils.debug.error("DSTQuery(element): ResourceIDNode is null" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster " or more than one resource id is found.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTUtils.bundle.getString("invalidResourceID"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster resourceID = XMLUtils.getElementValue((Element)list.item(0));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTUtils.debug.error("DSTQuery(element): ResourceID is null" );
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTUtils.bundle.getString("invalidResourceID"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster NodeList queryItemNodes = element.getElementsByTagNameNS(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if(queryItemNodes == null || queryItemNodes.getLength() == 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTUtils.debug.error("DSTQuery(element): QueryItems are null" );
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets the value of the <code>QueryItem</code> property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return List of <code>DSTQueryItem</code> objects
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the <code>QueryItem</code> property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param items List of <code>DSTQueryItem</code> objects
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setQueryItem(java.util.List items) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets id attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return id attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets id attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param id value of id to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets encrypted resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return Encrypted resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public com.sun.identity.liberty.ws.disco.EncryptedResourceID
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets encrypted resource ID for the <code>DST</code> query.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param encResourceID encrypted resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster com.sun.identity.liberty.ws.disco.EncryptedResourceID encResourceID) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return resource ID.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets resource ID for the <code>DST</code> query.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param resourceID resource ID to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setResourceID(java.lang.String resourceID) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets item ID attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return String
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets item ID attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value item ID to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setItemID(java.lang.String value) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets the extension property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return List of any Object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets the name space.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return name space.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the name space.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param nameSpace Name space URI.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setNameSpaceURI(String nameSpace) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the name space prefix.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param prefix Name space prefix.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setNameSpacePrefix(String prefix) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets the name space prefix.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return Name space prefix.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Creates a String representation of this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * By default name space name is prepended to the element name
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return String A string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return toString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Creates a String representation of this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param includeNS if true prepends all elements by their name space prefix
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param declareNS if true includes the name space within the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * generated.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return String A string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public java.lang.String toString(boolean includeNS, boolean declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if((encryptedResourceID == null && resourceID == null) ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTUtils.debug.error("DSTQuery.toString: ResourceID or QueryItems" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster " are null.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTUtils.debug.error("DSTQuery.toString: Name Space is " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "not defined");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append("<").append(tempPrefix).append("Query");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append(" itemID=\"").append(itemID).append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append(" xmlns:").append(prefix).append("=\"")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append("<").append(tempPrefix).append("ResourceID").append(">")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster .append(resourceID).append("</").append(tempPrefix)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append(encryptedResourceID.toString(nameSpaceURI));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append("</").append(tempPrefix).append("Query").append(">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster DSTUtils.debug.message("DSTQuery.toString: Query: " + sb.toString());