Package com.sun.identity.saml2.protocol

Interface ManageNameIDRequest

All Superinterfaces:

RequestAbstract, XmlSerializable

@SupportedAll
public interface ManageNameIDRequest
extends RequestAbstract

This class represents the ManageNameIDRequestType complex type.

The following schema fragment specifies the expected content contained within this java content object.

 <complexType name="ManageNameIDRequestType">
   <complexContent>
     <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}RequestAbstractType">
       <sequence>
         <choice>
           <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}NameID"/>
           <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedID"/>
         </choice>
         <choice>
           <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}NewID"/>
           <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}NewEncryptedID"/>
           <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}Terminate"/>
         </choice>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Method Summary

Modifier and Type	Method	Description
EncryptedID	getEncryptedID()	Returns the value of the encryptedID property.
NameID	getNameID()	Returns the value of the nameID property.
NewEncryptedID	getNewEncryptedID()	Returns the value of the newEncryptedID property.
NewID	getNewID()	Returns the value of the NewID property.
boolean	getTerminate()	Returns true if this is a terminating request.
void	setEncryptedID(EncryptedID value)	Sets the value of the encryptedID property.
void	setNameID(NameID value)	Sets the value of the nameID property.
void	setNewEncryptedID(NewEncryptedID value)	Sets the value of the newEncryptedID property.
void	setNewID(NewID value)	Sets the value of the NewID property.
void	setTerminate(boolean terminate)	Set this request as terminating request.

Methods inherited from interface com.sun.identity.saml2.protocol.RequestAbstract

getConsent, getDestination, getExtensions, getID, getIssueInstant, getIssuer, getSignature, getVersion, isMutable, isSignatureValid, isSigned, makeImmutable, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion, sign

Methods inherited from interface com.sun.identity.saml2.common.XmlSerializable

toDocumentFragment, toXMLString, toXMLString

Method Details

getNewEncryptedID

NewEncryptedID getNewEncryptedID()

Returns the value of the newEncryptedID property.

Returns:

the value of the newEncryptedID property.

setNewEncryptedID

void setNewEncryptedID(NewEncryptedID value)
                throws com.sun.identity.saml2.common.SAML2Exception

Sets the value of the newEncryptedID property.

Parameters:

value - the value of the newEncryptedID property.

Throws:

com.sun.identity.saml2.common.SAML2Exception - if Object is immutable.

getEncryptedID

EncryptedID getEncryptedID()

Returns the value of the encryptedID property.

Returns:

the value of the encryptedID property.

setEncryptedID

void setEncryptedID(EncryptedID value)
             throws com.sun.identity.saml2.common.SAML2Exception

Sets the value of the encryptedID property.

Parameters:

value - the value of the encryptedID property.

Throws:

com.sun.identity.saml2.common.SAML2Exception - if Object is immutable.

getNewID

NewID getNewID()

Returns the value of the NewID property.

Returns:

the value of the NewID property.

setNewID

void setNewID(NewID value)
       throws com.sun.identity.saml2.common.SAML2Exception

Sets the value of the NewID property.

Parameters:

value - the value of the NewID property.

Throws:

com.sun.identity.saml2.common.SAML2Exception - if Object is immutable.

getNameID

NameID getNameID()

Returns the value of the nameID property.

Returns:

the value of the nameID property.

setNameID

void setNameID(NameID value)
        throws com.sun.identity.saml2.common.SAML2Exception

Sets the value of the nameID property.

Parameters:

value - the value of the nameID property.

Throws:

com.sun.identity.saml2.common.SAML2Exception - if Object is immutable.

getTerminate

boolean getTerminate()

Returns true if this is a terminating request.

Returns:

true if this is a terminating request.

setTerminate

void setTerminate(boolean terminate)
           throws com.sun.identity.saml2.common.SAML2Exception

Set this request as terminating request.

Parameters:

terminate - true to set this request as terminating request.

Throws:

com.sun.identity.saml2.common.SAML2Exception - if this object is immutable.