com.cyclonecommerce.cybervan.api
Class InterchangeURL

java.lang.Object
  |
  +--com.cyclonecommerce.cybervan.api.InterchangeURL

All Implemented Interfaces:

java.io.Serializable

public class InterchangeURL

extends java.lang.Object

implements java.io.Serializable

Represents the information necessary to send and retreive documents using the Interchange API over HTTP or HTTPS. For use by remote clients only.

See Also:

Serialized Form

Field Summary

static java.lang.String	URL_INTERCHANGE_API
static java.lang.String	URL_VAR_BACKUPDOC
static java.lang.String	URL_VAR_CONTROLID
static java.lang.String	URL_VAR_CORRELATIONID
static java.lang.String	URL_VAR_DOCUMENTTYPE
static java.lang.String	URL_VAR_EBXML_ACTION
static java.lang.String	URL_VAR_EBXML_SERVICE
static java.lang.String	URL_VAR_NAME
static java.lang.String	URL_VAR_PACKAGING_TYPE
static java.lang.String	URL_VAR_PACKAGING_VERSION
static java.lang.String	URL_VAR_RECEIVEREDIID
static java.lang.String	URL_VAR_RECEIVERID
static java.lang.String	URL_VAR_RECEIVERNAME
static java.lang.String	URL_VAR_RECEIVERTRUEID
static java.lang.String	URL_VAR_REF_TO_MESSAGEID
static java.lang.String	URL_VAR_REFERENCE
static java.lang.String	URL_VAR_SENDEREDIID
static java.lang.String	URL_VAR_SENDERID
static java.lang.String	URL_VAR_SENDERNAME
static java.lang.String	URL_VAR_SENDERTRUEID
static java.lang.String	URL_VAR_SYNCHRONOUSSEND
static java.lang.String	URL_VAR_USERDATA
static java.lang.String	URL_VAR_USERKEY

Constructor Summary

InterchangeURL(java.lang.String host, java.lang.String port, IntegrationDocument document)
Constructor InterchangeURL - Construct a URL to use when posting a document to the Interchange API HTTP Server.

InterchangeURL(java.lang.String host, java.lang.String port, IntegrationDocument document, boolean backup)
Constructor InterchangeURL - Construct a URL to use when posting a document to the Interchange API HTTP Server.

InterchangeURL(java.lang.String host, java.lang.String port, IntegrationDocument document, boolean backup, boolean useHttps)
Constructor InterchangeURL - Construct a URL to use when posting a document to the Interchange API HTTP Server.

InterchangeURL(java.lang.String host, java.lang.String port, IntegrationDocument document, boolean backup, boolean useHttps, boolean synchronousSend)
Constructor InterchangeURL - Construct a URL to use when posting a document to the Interchange API HTTP Server.

Method Summary

java.lang.String	getURL() Get the URL used to send or retreive a document using HTTP or HTTPS.
java.lang.String	toString() Get the URL used to send or retreive a document using HTTP or HTTPS.

Methods inherited from class java.lang.Object

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

Field Detail

URL_INTERCHANGE_API

public static final java.lang.String URL_INTERCHANGE_API

URL_VAR_SENDERID

public static final java.lang.String URL_VAR_SENDERID

URL_VAR_SENDEREDIID

public static final java.lang.String URL_VAR_SENDEREDIID

URL_VAR_SENDERTRUEID

public static final java.lang.String URL_VAR_SENDERTRUEID

URL_VAR_SENDERNAME

public static final java.lang.String URL_VAR_SENDERNAME

URL_VAR_RECEIVERID

public static final java.lang.String URL_VAR_RECEIVERID

URL_VAR_RECEIVEREDIID

public static final java.lang.String URL_VAR_RECEIVEREDIID

URL_VAR_RECEIVERTRUEID

public static final java.lang.String URL_VAR_RECEIVERTRUEID

URL_VAR_RECEIVERNAME

public static final java.lang.String URL_VAR_RECEIVERNAME

URL_VAR_NAME

public static final java.lang.String URL_VAR_NAME

URL_VAR_DOCUMENTTYPE

public static final java.lang.String URL_VAR_DOCUMENTTYPE

URL_VAR_CONTROLID

public static final java.lang.String URL_VAR_CONTROLID

URL_VAR_REFERENCE

public static final java.lang.String URL_VAR_REFERENCE

URL_VAR_BACKUPDOC

public static final java.lang.String URL_VAR_BACKUPDOC

URL_VAR_SYNCHRONOUSSEND

public static final java.lang.String URL_VAR_SYNCHRONOUSSEND

URL_VAR_CORRELATIONID

public static final java.lang.String URL_VAR_CORRELATIONID

URL_VAR_REF_TO_MESSAGEID

public static final java.lang.String URL_VAR_REF_TO_MESSAGEID

URL_VAR_PACKAGING_TYPE

public static final java.lang.String URL_VAR_PACKAGING_TYPE

URL_VAR_PACKAGING_VERSION

public static final java.lang.String URL_VAR_PACKAGING_VERSION

URL_VAR_EBXML_SERVICE

public static final java.lang.String URL_VAR_EBXML_SERVICE

URL_VAR_EBXML_ACTION

public static final java.lang.String URL_VAR_EBXML_ACTION

URL_VAR_USERKEY

public static final java.lang.String URL_VAR_USERKEY

URL_VAR_USERDATA

public static final java.lang.String URL_VAR_USERDATA

Constructor Detail

InterchangeURL

public InterchangeURL(java.lang.String host,
                      java.lang.String port,
                      IntegrationDocument document,
                      boolean backup,
                      boolean useHttps,
                      boolean synchronousSend)

Constructor InterchangeURL - Construct a URL to use when posting a document to the Interchange API HTTP Server.

Parameters:

host - Interchange API HTTP Server host name.

port - HTTP Port that the host is listening on.

document - document that will be posted to Interchange.

backup - True to have Interchange backup an outbound document. True also ensures that the document will be placed in the resend queue if there is a failure sending the document. False instructs Interchange to package the document immediately without backup, and without resend capability.

useHttps - True if using the Interchange API HTTPS port. False if using the Interchange API HTTP Port.

synchronousSend - Package and send the document immediately. Control is not returned to the client until the document has ben packaged and sent.

InterchangeURL

public InterchangeURL(java.lang.String host,
                      java.lang.String port,
                      IntegrationDocument document,
                      boolean backup,
                      boolean useHttps)

Constructor InterchangeURL - Construct a URL to use when posting a document to the Interchange API HTTP Server.

Parameters:

host - Interchange API HTTP Server host name.

port - HTTP Port that the host is listening on.

document - document that will be posted to Interchange.

backup - True to have Interchange backup an outbound document. True also ensures that the document will be placed in the resend queue if there is a failure sending the document. False instructs Interchange to package the document immediately without backup, and without resend capability.

useHttps - True if using the Interchange API HTTPS port. False if using the Interchange API HTTP Port.

InterchangeURL

public InterchangeURL(java.lang.String host,
                      java.lang.String port,
                      IntegrationDocument document,
                      boolean backup)

Constructor InterchangeURL - Construct a URL to use when posting a document to the Interchange API HTTP Server.

Parameters:

host - Interchange API HTTP Server host name.

port - HTTP Port that the host is listening on.

document - document that will be posted to Interchange.

backup - True to have Interchange backup an outbound document. True also ensures that the document will be placed in the resend queue if there is a failure sending the document. False instructs Interchange to package the document immediately without backup, and without resend capability.

InterchangeURL

public InterchangeURL(java.lang.String host,
                      java.lang.String port,
                      IntegrationDocument document)

Constructor InterchangeURL - Construct a URL to use when posting a document to the Interchange API HTTP Server.

Parameters:

host - Interchange API HTTP Server host name.

port - HTTP Port that the host is listening on.

document - document that will be posted to Interchange.

Method Detail

getURL

public java.lang.String getURL()

Get the URL used to send or retreive a document using HTTP or HTTPS. The URL will only be valid if the Interchange Server has the HTTP or HTTPS API support enabled.

Returns:

the host URL

toString

public java.lang.String toString()

Get the URL used to send or retreive a document using HTTP or HTTPS. The URL will only be valid if the Interchange Server has the HTTP or HTTPS API support enabled.

Overrides:

toString in class java.lang.Object

Returns:

the host URL