|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.saml.protocol.AbstractRequest com.sun.identity.federation.message.FSNameRegistrationRequest
public class FSNameRegistrationRequest
This class contains methods to create NameRegistrationRequest
object.
Field Summary | |
---|---|
protected String |
id
|
protected int |
minorVersion
|
protected String |
signatureString
|
protected String |
xmlString
|
Fields inherited from class com.sun.identity.saml.protocol.AbstractRequest |
---|
issueInstant, majorVersion, requestID, respondWiths, signature, signed, valid |
Constructor Summary | |
---|---|
FSNameRegistrationRequest()
Default Constructor. |
|
FSNameRegistrationRequest(Element root)
Constructor creates FSNameRegistrationRequest > object
from a Document Element. |
|
FSNameRegistrationRequest(String requestId,
List respondWiths,
String providerId,
SPProvidedNameIdentifier spProvidedNameIdentifier,
IDPProvidedNameIdentifier idpProvidedNameIdentifier,
OldProvidedNameIdentifier oldProvidedNameIdentifier,
String relayState)
Constructor creates the FSNameRegistrationRequest
object. |
Method Summary | |
---|---|
String |
getID()
Returns the value of id attribute. |
IDPProvidedNameIdentifier |
getIDPProvidedNameIdentifier()
Returns the Identity Provider's NameIdentifier . |
int |
getMinorVersion()
Returns the MinorVersion . |
OldProvidedNameIdentifier |
getOldProvidedNameIdentifier()
Returns the original NameIdentifier . |
String |
getProviderId()
Returns the value of ProviderID attribute. |
String |
getRelayState()
Returns the value of RelayState attribute. |
String |
getSignatureString()
Returns the signed XML string. |
SPProvidedNameIdentifier |
getSPProvidedNameIdentifier()
Returns the NameIdentifier provided by
the Service Provider. |
static FSNameRegistrationRequest |
parseURLEncodedRequest(HttpServletRequest request)
Returns FSNameRegistrationRequest object. |
static FSNameRegistrationRequest |
parseXML(String xml)
|
void |
setID(String id)
Sets the value of id attribute. |
void |
setIDPProvidedNameIdentifier(IDPProvidedNameIdentifier nameIdentifier)
Sets the Identity Provider's NameIdentifier . |
void |
setMinorVersion(int version)
Sets the MinorVersion . |
void |
setOldProvidedNameIdentifier(OldProvidedNameIdentifier nameIdentifier)
Sets the original NameIdentifier . |
void |
setProviderId(String providerId)
Sets the value of ProviderID attribute. |
void |
setRelayState(String relayState)
Set the value of RelayState attribute. |
boolean |
setSignature(Element elem)
Sets the Signature. |
void |
setSPProvidedNameIdentifier(SPProvidedNameIdentifier nameIdentifier)
Sets the Service Provider's NameIdentifier . |
void |
signXML()
An abstract method to sign the object. |
void |
signXML(String certAlias)
Signs the FSNameRegistrationRequest object. |
String |
toBASE64EncodedString()
Returns a Base64 Encoded String. |
String |
toURLEncodedQueryString()
Returns an URL Encoded String. |
String |
toXMLString()
Returns a String representation of the Logout Response. |
String |
toXMLString(boolean includeNS,
boolean declareNS)
Returns a String representation of the Logout Response. |
String |
toXMLString(boolean includeNS,
boolean declareNS,
boolean includeHeader)
Returns a String representation of the Logout Response. |
Methods inherited from class com.sun.identity.saml.protocol.AbstractRequest |
---|
addRespondWith, getIssueInstant, getMajorVersion, getRequestID, getRespondWith, getSignature, isSignatureValid, isSigned, setIssueInstant, setMajorVersion, setRequestID |
Field Detail |
---|
protected String xmlString
protected String signatureString
protected String id
protected int minorVersion
Constructor Detail |
---|
public FSNameRegistrationRequest()
public FSNameRegistrationRequest(String requestId, List respondWiths, String providerId, SPProvidedNameIdentifier spProvidedNameIdentifier, IDPProvidedNameIdentifier idpProvidedNameIdentifier, OldProvidedNameIdentifier oldProvidedNameIdentifier, String relayState) throws FSMsgException
FSNameRegistrationRequest
object.
requestId
- the value of RequestID
attribute.respondWiths
- the value of RespondWiths
attribute.providerId
- the value of ProviderID
attribute.spProvidedNameIdentifier
- the Service Provider
NameIdentifier
.idpProvidedNameIdentifier
- the Identity Provider
NameIdentifier
.oldProvidedNameIdentifier
- the Original Provider
NameIdentifier
.relayState
- the value of RelayState
attribute.
FSMsgException
- if there is an error creating this object.public FSNameRegistrationRequest(Element root) throws FSMsgException
FSNameRegistrationRequest
> object
from a Document Element.
root
- the Document Element.
FSMsgException
- if there is an error creating
this object.Method Detail |
---|
public String getID()
id
attribute.
id
attribute.FSNameRegistrationRequest.setID(String)
public void setID(String id)
id
attribute.
id
- the value of id
attribute.FSNameRegistrationRequest.getID()
public String getRelayState()
RelayState
attribute.
RelayState
attribute.FSNameRegistrationRequest.setRelayState(String)
public void setRelayState(String relayState)
RelayState
attribute.
relayState
- the value of RelayState
attribute.FSNameRegistrationRequest.getRelayState()
public String getSignatureString()
XML
string.
XML
string.public int getMinorVersion()
MinorVersion
.
getMinorVersion
in class AbstractRequest
MinorVersion
.FSNameRegistrationRequest.setMinorVersion(int)
public void setMinorVersion(int version)
MinorVersion
.
setMinorVersion
in class AbstractRequest
version
- the MinorVersion
.FSNameRegistrationRequest.getMinorVersion()
public static FSNameRegistrationRequest parseXML(String xml) throws FSMsgException
FSMsgException
public String toXMLString() throws FSMsgException
FSMsgException
- if there is an error converting
this object ot a string.public String toXMLString(boolean includeNS, boolean declareNS) throws FSMsgException
includeNS
- : Determines whether or not the namespace qualifier
is prepended to the Element when converteddeclareNS
- : Determines whether or not the namespace is declared
within the Element.
FSMsgException
- if there is an error converting
this object ot a string.public String toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) throws FSMsgException
includeNS
- Determines whether or not the namespace qualifier
is prepended to the Element when converteddeclareNS
- Determines whether or not the namespace is declared
within the Element.includeHeader
- Determines whether the output include the xml
declaration header.
FSMsgException
- if there is an error converting
this object ot a string.public IDPProvidedNameIdentifier getIDPProvidedNameIdentifier()
NameIdentifier
.
NameIdentifier
.public OldProvidedNameIdentifier getOldProvidedNameIdentifier()
NameIdentifier
.
NameIdentifier
.public String getProviderId()
ProviderID
attribute.
ProviderID
attribute.FSNameRegistrationRequest.setProviderId(String).
public void setIDPProvidedNameIdentifier(IDPProvidedNameIdentifier nameIdentifier)
NameIdentifier
.
nameIdentifier
- the Identity Provider's
NameIdentifier
.FSNameRegistrationRequest.getIDPProvidedNameIdentifier()
public void setOldProvidedNameIdentifier(OldProvidedNameIdentifier nameIdentifier)
NameIdentifier
.
nameIdentifier
- the original provider's
NameIdentifier
.FSNameRegistrationRequest.getOldProvidedNameIdentifier()
public void setSPProvidedNameIdentifier(SPProvidedNameIdentifier nameIdentifier)
NameIdentifier
.
nameIdentifier
- the Identity Provider's
NameIdentifier
.FSNameRegistrationRequest.getSPProvidedNameIdentifier()
public void setProviderId(String providerId)
ProviderID
attribute.
providerId
- the value of ProviderID
attribute.public SPProvidedNameIdentifier getSPProvidedNameIdentifier()
NameIdentifier
provided by
the Service Provider.
NameIdentifier
provided by
the Service Provider.FSNameRegistrationRequest.setSPProvidedNameIdentifier(SPProvidedNameIdentifier)
public String toBASE64EncodedString() throws FSMsgException
FSMsgException
- if there is an error encoding the string.public void signXML()
AbstractRequest
signXML
in class AbstractRequest
public void signXML(String certAlias) throws SAMLException
FSNameRegistrationRequest
object.
certAlias
- the Certificate Alias.
SAMLException
- if this object cannot be signed.public boolean setSignature(Element elem)
setSignature
in class AbstractRequest
elem
- the Document Element.
public String toURLEncodedQueryString() throws FSMsgException
FSMsgException
- if there is an error.public static FSNameRegistrationRequest parseURLEncodedRequest(HttpServletRequest request) throws FSMsgException, SAMLException
FSNameRegistrationRequest
object. The
object is creating by parsing the HttpServletRequest
object.
request
- the HttpServletRequest
object.
FSMsgException
- if there is an error
creating this object.
SAMLException
- if there is an error.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |