org.openliberty.xmltooling.idsis.dap
Class DAPQuery

java.lang.Object
  extended by org.opensaml.xml.AbstractXMLObject
      extended by org.openliberty.xmltooling.dst2_1.RequestType
          extended by org.openliberty.xmltooling.idsis.dap.DAPQuery
All Implemented Interfaces:
org.opensaml.xml.AttributeExtensibleXMLObject, org.opensaml.xml.XMLObject

public class DAPQuery
extends RequestType

This class is based on the DST 2.1 Reference implementation Query but adds Subscriptions

   <xs:complexType name="QueryType">
     <xs:complexContent>
       <xs:extension base="dst:RequestType">
         <xs:sequence>
           <xs:element ref="dap:TestItem"  minOccurs="0" maxOccurs="unbounded"/>
           <xs:element ref="dap:QueryItem" minOccurs="0" maxOccurs="unbounded"/>
           <xs:element ref="dap:Subscription"  minOccurs="0" maxOccurs="unbounded"/>
         </xs:sequence>
       </xs:extension>
     </xs:complexContent>
   </xs:complexType>
 

Author:
asa

Nested Class Summary
static class DAPQuery.Builder
          Internal class for the builder to simplify the class structure
static class DAPQuery.Marshaller
           
static class DAPQuery.Unmarshaller
          Internal class that handles unmarshalling specific to DAPQuery
 
Field Summary
static java.lang.String LOCAL_NAME
           
private  org.opensaml.xml.util.XMLObjectChildrenList<DAPQueryItem> queryItems
           
private  org.opensaml.xml.util.XMLObjectChildrenList<DAPSubscription> subscriptions
           
private  org.opensaml.xml.util.XMLObjectChildrenList<DAPTestItem> testItems
           
 
Fields inherited from class org.openliberty.xmltooling.dst2_1.RequestType
ATT_ITEM_ID
 
Constructor Summary
DAPQuery()
           
DAPQuery(java.lang.String namespaceURI, java.lang.String elementLocalName, java.lang.String namespacePrefix)
           
 
Method Summary
static DAPQuery entityQueryWithSelectAttributes(java.lang.String selectAttributes, java.lang.String itemId)
          Convenience method to generate a simple entity attribute Select.
 org.opensaml.xml.util.XMLObjectChildrenList<DAPQueryItem> getDAPQueryItems()
           
 org.opensaml.xml.util.XMLObjectChildrenList<DAPSubscription> getDAPSubscriptions()
           
 org.opensaml.xml.util.XMLObjectChildrenList<DAPTestItem> getDAPTestItems()
           
 java.util.List<org.opensaml.xml.XMLObject> getOrderedChildren()
           
 
Methods inherited from class org.openliberty.xmltooling.dst2_1.RequestType
getExtensions, getItemID, getUnknownAttributes, setItemID
 
Methods inherited from class org.opensaml.xml.AbstractXMLObject
addNamespace, getDOM, getElementQName, getIDIndex, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, prepareForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opensaml.xml.XMLObject
addNamespace, getDOM, getElementQName, getIDIndex, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNoNamespaceSchemaLocation, setParent, setSchemaLocation
 

Field Detail

LOCAL_NAME

public static java.lang.String LOCAL_NAME

testItems

private org.opensaml.xml.util.XMLObjectChildrenList<DAPTestItem> testItems

queryItems

private org.opensaml.xml.util.XMLObjectChildrenList<DAPQueryItem> queryItems

subscriptions

private org.opensaml.xml.util.XMLObjectChildrenList<DAPSubscription> subscriptions
Constructor Detail

DAPQuery

public DAPQuery()

DAPQuery

public DAPQuery(java.lang.String namespaceURI,
                java.lang.String elementLocalName,
                java.lang.String namespacePrefix)
Method Detail

entityQueryWithSelectAttributes

public static DAPQuery entityQueryWithSelectAttributes(java.lang.String selectAttributes,
                                                       java.lang.String itemId)
Convenience method to generate a simple entity attribute Select.

In the ID-SIS-DAP world the DN is usually gleaned from the identity information provided by the WSF layer. Therefore it is likely that a query based on an attribute will be created with the DN implied.

This method will generate a Query that looks like this:

 
 

Parameters:
selectAttributes -
itemId -
Returns:

getDAPQueryItems

public org.opensaml.xml.util.XMLObjectChildrenList<DAPQueryItem> getDAPQueryItems()

getDAPTestItems

public org.opensaml.xml.util.XMLObjectChildrenList<DAPTestItem> getDAPTestItems()

getDAPSubscriptions

public org.opensaml.xml.util.XMLObjectChildrenList<DAPSubscription> getDAPSubscriptions()

getOrderedChildren

public java.util.List<org.opensaml.xml.XMLObject> getOrderedChildren()
Specified by:
getOrderedChildren in interface org.opensaml.xml.XMLObject
Overrides:
getOrderedChildren in class RequestType