com.exalead.mercury.mami.fetch.v21

Class Post

java.lang.Object

com.exalead.mercury.mami.fetch.v21.Post

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class Post
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	action
java.lang.String	additionalRequest
int	autoSubmittedForms
static int	DEFAULT_AUTO_SUBMITTED_FORMS
java.lang.String	formClass
java.lang.String	formId
java.lang.String	formName
java.lang.String	gatewayUrl
java.util.List<KeyValue>	keyValue
java.lang.String	method

Constructor Summary

Constructors

Constructor and Description
Post()
Post(Post o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Post.
static Post	fromString(java.lang.String s) String representation of this Post.
java.lang.String	getAction()
java.lang.String	getAdditionalRequest() An additional URL to fetch after the HTML form authentication procedure, following all redirections to allow new cookies. Useful for some SSO including google sites.
int	getAutoSubmittedForms() How many times to try to find and submit a form after the login procedure. This is needed to get cookies for other domains in some SSOs.
java.lang.String	getFormClass()
java.lang.String	getFormId() if there are more than one form on the gateway Url, a formName formId and/or a formClass can be specified to find the right one.
java.lang.String	getFormName()
java.lang.String	getGatewayUrl()
java.util.List<KeyValue>	getKeyValue()
java.lang.String	getMethod() when method or action are not null, they override the ones found in the form. when gatewayUrl is null, just use them. gatewayUrl, method and action must not all be null.
Post	makeCopy() Creates and returns a deep copy of this Post.
static Post	readFrom(java.io.InputStream is) Read this Post from an XML fragment.
void	setAction(java.lang.String action)
void	setAdditionalRequest(java.lang.String additionalRequest) An additional URL to fetch after the HTML form authentication procedure, following all redirections to allow new cookies. Useful for some SSO including google sites.
void	setAutoSubmittedForms(int autoSubmittedForms) How many times to try to find and submit a form after the login procedure. This is needed to get cookies for other domains in some SSOs.
void	setFormClass(java.lang.String formClass)
void	setFormId(java.lang.String formId) if there are more than one form on the gateway Url, a formName formId and/or a formClass can be specified to find the right one.
void	setFormName(java.lang.String formName)
void	setGatewayUrl(java.lang.String gatewayUrl)
void	setMethod(java.lang.String method) when method or action are not null, they override the ones found in the form. when gatewayUrl is null, just use them. gatewayUrl, method and action must not all be null.
java.lang.String	toString() String representation of this Post.
Post	withAction(java.lang.String action)
Post	withAdditionalRequest(java.lang.String additionalRequest)
Post	withAutoSubmittedForms(int autoSubmittedForms)
Post	withAutoSubmittedForms(java.lang.Integer autoSubmittedForms)
Post	withFormClass(java.lang.String formClass)
Post	withFormId(java.lang.String formId)
Post	withFormName(java.lang.String formName)
Post	withGatewayUrl(java.lang.String gatewayUrl)
Post	withKeyValue(java.util.Collection<KeyValue> __values)
Post	withKeyValue(KeyValue... __values)
Post	withMethod(java.lang.String method)
void	writeTo(java.io.OutputStream os) Write this Post as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

keyValue

public java.util.List<KeyValue> keyValue

gatewayUrl

public java.lang.String gatewayUrl

formId

public java.lang.String formId

formClass

public java.lang.String formClass

formName

public java.lang.String formName

method

public java.lang.String method

action

public java.lang.String action

autoSubmittedForms

public int autoSubmittedForms

DEFAULT_AUTO_SUBMITTED_FORMS

public static final int DEFAULT_AUTO_SUBMITTED_FORMS

See Also:

Constant Field Values

additionalRequest

public java.lang.String additionalRequest

Constructor Detail

Post

public Post()

Post

public Post(Post o)

Copy constructor

Method Detail

getKeyValue

public java.util.List<KeyValue> getKeyValue()

withKeyValue

public Post withKeyValue(KeyValue... __values)

withKeyValue

public Post withKeyValue(java.util.Collection<KeyValue> __values)

setGatewayUrl

public void setGatewayUrl(java.lang.String gatewayUrl)

getGatewayUrl

public java.lang.String getGatewayUrl()

withGatewayUrl

public Post withGatewayUrl(java.lang.String gatewayUrl)

setFormId

public void setFormId(java.lang.String formId)

if there are more than one form on the gateway Url, a formName
formId and/or a formClass can be specified to find the right one.

getFormId

public java.lang.String getFormId()

if there are more than one form on the gateway Url, a formName
formId and/or a formClass can be specified to find the right one.

withFormId

public Post withFormId(java.lang.String formId)

setFormClass

public void setFormClass(java.lang.String formClass)

getFormClass

public java.lang.String getFormClass()

withFormClass

public Post withFormClass(java.lang.String formClass)

setFormName

public void setFormName(java.lang.String formName)

getFormName

public java.lang.String getFormName()

withFormName

public Post withFormName(java.lang.String formName)

setMethod

public void setMethod(java.lang.String method)

when method or action are not null, they override the ones found in the
form.
when gatewayUrl is null, just use them.
gatewayUrl, method and action must not all be null.

getMethod

public java.lang.String getMethod()

when method or action are not null, they override the ones found in the
form.
when gatewayUrl is null, just use them.
gatewayUrl, method and action must not all be null.

withMethod

public Post withMethod(java.lang.String method)

setAction

public void setAction(java.lang.String action)

getAction

public java.lang.String getAction()

withAction

public Post withAction(java.lang.String action)

setAutoSubmittedForms

public void setAutoSubmittedForms(int autoSubmittedForms)

How many times to try to find and submit a form after the login procedure.
This is needed to get cookies for other domains in some SSOs.

getAutoSubmittedForms

public int getAutoSubmittedForms()

How many times to try to find and submit a form after the login procedure.
This is needed to get cookies for other domains in some SSOs.

withAutoSubmittedForms

public Post withAutoSubmittedForms(int autoSubmittedForms)

withAutoSubmittedForms

public Post withAutoSubmittedForms(java.lang.Integer autoSubmittedForms)

setAdditionalRequest

public void setAdditionalRequest(java.lang.String additionalRequest)

An additional URL to fetch after the HTML form authentication procedure,
following all redirections to allow new cookies.
Useful for some SSO including google sites.

getAdditionalRequest

public java.lang.String getAdditionalRequest()

An additional URL to fetch after the HTML form authentication procedure,
following all redirections to allow new cookies.
Useful for some SSO including google sites.

withAdditionalRequest

public Post withAdditionalRequest(java.lang.String additionalRequest)

makeCopy

public Post makeCopy()

Creates and returns a deep copy of this Post.

readFrom

public static Post readFrom(java.io.InputStream is)
                     throws javax.xml.bind.JAXBException

Read this Post from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this Post as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static Post fromString(java.lang.String s)
                       throws javax.xml.bind.JAXBException,
                              java.io.UnsupportedEncodingException

String representation of this Post.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Post.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this Post.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException