com.sun.identity.liberty.ws.dst

Class DSTQuery

java.lang.Object

com.sun.identity.liberty.ws.dst.DSTQuery

public class DSTQuery
extends Object

The DSTQuery class represents a DST query request.

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

 <complexType name="QueryType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{urn:liberty:idpp:2003-08}ResourceIDGroup"/>
         <element name="QueryItem" maxOccurs="unbounded">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}
               anyType">
                 <sequence>
                   <element name="Select" 
                   type="{urn:liberty:idpp:2003-08}SelectType"/>
                 </sequence>
                 <attribute name="id"
                 type="{http://www.w3.org/2001/XMLSchema}ID" />
                 <attribute name="changedSince"
                 type="{http://www.w3.org/2001/XMLSchema}dateTime" />
                 <attribute name="itemID"
                 type="{urn:liberty:idpp:2003-08}IDType" />
                 <attribute name="includeCommonAttributes"
                 type="{http://www.w3.org/2001/XMLSchema}boolean" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element ref="{urn:liberty:idpp:2003-08}Extension"
         maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="itemID" type="{urn:liberty:idpp:2003-08}IDType" />
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Constructor Summary

Constructors

Constructor and Description
DSTQuery() Constructor
DSTQuery(Element element) Constructor
DSTQuery(EncryptedResourceID encResourceID, List items, String serviceNS) Constructor
DSTQuery(String resourceID, List items, String serviceNS) Constructor

Method Summary

Modifier and Type	Method and Description
EncryptedResourceID	getEncryptedResourceID() Gets encrypted resource ID.
List	getExtension() Gets the extension property.
String	getId() Gets id attribute.
String	getItemID() Gets item ID attribute
String	getNameSpacePrefix() Gets the name space prefix.
String	getNameSpaceURI() Gets the name space.
List	getQueryItems() Gets the value of the QueryItem property.
String	getResourceID() Gets resource ID.
void	setEncryptedResourceID(EncryptedResourceID encResourceID) Sets encrypted resource ID for the DST query.
void	setId(String id) Sets id attribute
void	setItemID(String value) Sets item ID attribute
void	setNameSpacePrefix(String prefix) Sets the name space prefix.
void	setNameSpaceURI(String nameSpace) Sets the name space.
void	setQueryItem(List items) Sets the value of the QueryItem property.
void	setResourceID(String resourceID) Sets resource ID for the DST query.
String	toString() Creates a String representation of this object.
String	toString(boolean includeNS, boolean declareNS) Creates a String representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DSTQuery

public DSTQuery()

Constructor

DSTQuery

public DSTQuery(String resourceID,
                List items,
                String serviceNS)

Constructor

Parameters:

resourceID - id for the resource to be queried.

items - List of DSTQueryItem objects.

serviceNS - service name space.

DSTQuery

public DSTQuery(EncryptedResourceID encResourceID,
                List items,
                String serviceNS)

Constructor

Parameters:

encResourceID - id for the encrypted resource to be queried.

items - list of DSTQueryItem objects.

serviceNS - service name space.

DSTQuery

public DSTQuery(Element element)
         throws DSTException

Constructor

Parameters:

element - DOM Element.

Throws:

DSTException - If there was an error while parsing the XML.

Method Detail

getQueryItems

public List getQueryItems()

Gets the value of the QueryItem property.

Returns:

List of DSTQueryItem objects

setQueryItem

public void setQueryItem(List items)

Sets the value of the QueryItem property.

Parameters:

items - List of DSTQueryItem objects

getId

public String getId()

Gets id attribute.

Returns:

id attribute.

setId

public void setId(String id)

Sets id attribute

Parameters:

id - value of id to be set

getEncryptedResourceID

public EncryptedResourceID getEncryptedResourceID()

Gets encrypted resource ID.

Returns:

Encrypted resource ID.

setEncryptedResourceID

public void setEncryptedResourceID(EncryptedResourceID encResourceID)

Sets encrypted resource ID for the DST query.

Parameters:

encResourceID - encrypted resource ID.

getResourceID

public String getResourceID()

Gets resource ID.

Returns:

resource ID.

setResourceID

public void setResourceID(String resourceID)

Sets resource ID for the DST query.

Parameters:

resourceID - resource ID to be set

getItemID

public String getItemID()

Gets item ID attribute

Returns:

String

setItemID

public void setItemID(String value)

Sets item ID attribute

Parameters:

value - item ID to be set

getExtension

public List getExtension()

Gets the extension property.

Returns:

List of any Object

getNameSpaceURI

public String getNameSpaceURI()

Gets the name space.

Returns:

name space.

setNameSpaceURI

public void setNameSpaceURI(String nameSpace)

Sets the name space.

Parameters:

nameSpace - Name space URI.

setNameSpacePrefix

public void setNameSpacePrefix(String prefix)

Sets the name space prefix.

Parameters:

prefix - Name space prefix.

getNameSpacePrefix

public String getNameSpacePrefix()

Gets the name space prefix.

Returns:

Name space prefix.

toString

public String toString()

Creates a String representation of this object. By default name space name is prepended to the element name

Overrides:

toString in class Object

Returns:

String A string containing the valid XML for this element

toString

public String toString(boolean includeNS,
                       boolean declareNS)

Creates a String representation of this object.

Parameters:

includeNS - if true prepends all elements by their name space prefix

declareNS - if true includes the name space within the generated.

Returns:

String A string containing the valid XML for this element