com.sun.identity.liberty.ws.dst

Class DSTModify

java.lang.Object

com.sun.identity.liberty.ws.dst.DSTModify

public class DSTModify
extends Object

The DSTModify class represents a DST modify request. The following schema fragment specifies the expected content within the DSTModify object.

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

Constructor Summary

Constructors

Constructor and Description
DSTModify() Constructor
DSTModify(Element element) Constructor
DSTModify(EncryptedResourceID encResourceID, List modifications, String serviceNS) Constructor
DSTModify(String resourceID, List modifications, String serviceNS) Constructor

Method Summary

Modifier and Type	Method and Description
EncryptedResourceID	getEncryptedResourceID() Gets the encrypted resource ID.
List	getExtension() Gets the extension property
String	getId() Gets id attribute
String	getItemID() Gets item id attribute
List	getModification() Gets the modifications to be performed.
String	getNameSpacePrefix() Gets the name space prefix.
String	getNameSpaceURI() Gets the name space.
String	getResourceID() Gets resource ID
void	setEncryptedResourceID(EncryptedResourceID resourceID) Sets encrypted resource ID
void	setExtension(List extensions) Sets the extension property
void	setId(String id) Sets id attribute
void	setItemID(String itemID) Sets item id attribute
void	setNameSpacePrefix(String prefix) Sets the name space prefix.
void	setNameSpaceURI(String nameSpace) Sets the name space.
void	setResourceID(String resourceID) Sets the resource ID
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

DSTModify

public DSTModify()

Constructor

DSTModify

public DSTModify(String resourceID,
                 List modifications,
                 String serviceNS)

Constructor

Parameters:

resourceID - id for the resource to be modified.

modifications - list of DSTModification to be performed.

serviceNS - service name space.

DSTModify

public DSTModify(EncryptedResourceID encResourceID,
                 List modifications,
                 String serviceNS)

Constructor

Parameters:

encResourceID - id for encrypted resource to be modified.

modifications - list of DSTModification to be performed.

serviceNS - service name space.

DSTModify

public DSTModify(Element element)
          throws DSTException

Constructor

Parameters:

element - DOM Element.

Throws:

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

Method Detail

getModification

public List getModification()

Gets the modifications to be performed.

Returns:

List of DSTModification object

getId

public String getId()

Gets id attribute

Returns:

String

setId

public void setId(String id)

Sets id attribute

Parameters:

id - id attribute value to be set

getEncryptedResourceID

public EncryptedResourceID getEncryptedResourceID()

Gets the encrypted resource ID.

Returns:

encrypted resource ID.

setEncryptedResourceID

public void setEncryptedResourceID(EncryptedResourceID resourceID)

Sets encrypted resource ID

Parameters:

resourceID - encrypted resource ID to be set

getResourceID

public String getResourceID()

Gets resource ID

Returns:

String

setResourceID

public void setResourceID(String resourceID)

Sets the resource ID

Parameters:

resourceID - resource ID to be set

getItemID

public String getItemID()

Gets item id attribute

Returns:

String

setItemID

public void setItemID(String itemID)

Sets item id attribute

Parameters:

itemID - item ID to be set

getExtension

public List getExtension()

Gets the extension property

Returns:

List of Object

setExtension

public void setExtension(List extensions)

Sets the extension property

Parameters:

extensions - List of Object to be set

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