com.adobe.livecycle.formsservice.client
Class URLSpec

java.lang.Object
  com.adobe.livecycle.formsservice.client.URLSpec

All Implemented Interfaces:

java.io.Serializable

public class URLSpec
extends java.lang.Object
implements java.io.Serializable

Enables you to set URI values that are required by the Forms service when rendering forms. Using this object, you define URI values such as the location where form designs are located. An object of this type is passed to the following FormsServiceClient methods:

• renderFormGuide
• renderHTMLForm
• renderPDFForm
• renderPDFFormWithUsageRights

To see an instance of this type used in a code example, see the Rendering an interactive PDF form using the Java API quick start in Programming with LiveCycle ES4.

See Also:

Serialized Form

Constructor Summary

URLSpec()
A standard constructor.

URLSpec(java.lang.String optionsString)
A constructor that enables you to specify a standard query string.

URLSpec(java.lang.String applicationWebRoot, java.lang.String targetURL, java.lang.String contentRootURI, java.lang.String baseURL)
A constructor that enables you to set all options.

Method Summary

java.lang.String	getApplicationWebRoot() Returns the application's web root.
java.lang.String	getBaseURL() Returns a string value that represents the base URL.
java.lang.String	getContentRootURI() Returns a string value that specifies a URI or an absolute reference to a location from which forms are retrieved.
java.lang.String	getOption(java.lang.String key) Returns the value of the specified option.
java.lang.String	getOptions() For internal use only.
java.lang.String	getTargetURL() Returns a string value that specifies the URL to a web service or Java servlet that receives the posted data from a target device (typically, a web browser).
void	setApplicationWebRoot(java.lang.String applicationWebRoot) Sets the application's web root.
void	setBaseURL(java.lang.String baseURL) Sets the base URL, which must be the HTTP-equivalent of the content root URI and is required for HTML transformations that include HREF references to external dependencies, such as images or scripts.
void	setContentRootURI(java.lang.String contentRootURI) Sets the URI value or an absolute reference to a location from which forms are retrieved.
void	setTargetURL(java.lang.String targetURL) Sets a string value that specifies the URL to a web service or Java servlet that receives the posted data from a target device (typically, a web browser).
java.lang.String	toString() For internal use only.
void	updateOptionsBean(java.lang.String options) For internal purposes only.
void	updateOptionsBean(java.lang.String key, java.lang.String value) For internal purposes only.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

URLSpec

public URLSpec()

A standard constructor.

URLSpec

public URLSpec(java.lang.String optionsString)

A constructor that enables you to specify a standard query string.

URLSpec

public URLSpec(java.lang.String applicationWebRoot,
               java.lang.String targetURL,
               java.lang.String contentRootURI,
               java.lang.String baseURL)

A constructor that enables you to set all options.

Method Detail

getApplicationWebRoot

public java.lang.String getApplicationWebRoot()

Returns the application's web root. This value is combined with target URL value to construct an absolute URL to access application-specific web content.

Returns:

A string value that specifies the application's web root.

setApplicationWebRoot

public void setApplicationWebRoot(java.lang.String applicationWebRoot)

Sets the application's web root. This value is combined with target URL value to construct an absolute URL to access application-specific web content.

To see this method used in a code example, see the Rendering an interactive PDF form using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

applicationWebRoot - A string value that specifies the application's web root.

getBaseURL

public java.lang.String getBaseURL()

Returns a string value that represents the base URL. This value must be the HTTP-equivalent of the content root URI and is required for HTML transformations that include HREF references to external dependencies, such as images or scripts. When a dependency path is absolute, this value is ignored.

Returns:

A string value that represents the base URL.

See Also:

setBaseURL()

setBaseURL

public void setBaseURL(java.lang.String baseURL)

Sets the base URL, which must be the HTTP-equivalent of the content root URI and is required for HTML transformations that include HREF references to external dependencies, such as images or scripts. When a dependency path is absolute, this value is ignored.

Parameters:

baseURL - A string value that represents the base URL.

See Also:

getBaseURL()

getContentRootURI

public java.lang.String getContentRootURI()

Returns a string value that specifies a URI or an absolute reference to a location from which forms are retrieved. This value is combined with the form query value (defined by the first parameter passed to a render method such as renderPDFForm()) to construct an absolute path to the form that is retrieved. This value can reference the LiveCycle Repository, a local directory, a network directory, or a web location that is accessible by using HTTP.

Returns:

A string value that specifies a URI or an absolute reference to a location from which forms are retrieved.

See Also:

setContentRootURI()

setContentRootURI

public void setContentRootURI(java.lang.String contentRootURI)

Sets the URI value or an absolute reference to a location from which forms are retrieved. This value is combined with the form query value (defined by the first parameter passed to a render method such as renderPDFForm()) to construct an absolute path to the form that is retrieved. This value can reference the LiveCycle Repository, a local directory, a network directory, or a web location that is accessible by using HTTP. To reference the LiveCycle Repository, specify repository://.

To see this method used in a code example, see the Rendering an interactive PDF form using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

contentRootURI - A string value that specifies a URI or an absolute reference to a location from which forms are retrieved.

See Also:

getContentRootURI()

getTargetURL

public java.lang.String getTargetURL()

Returns a string value that specifies the URL to a web service or Java servlet that receives the posted data from a target device (typically, a web browser). This URL is inserted into the transformed output resulting in a submit operation invoking this URL. If not an absolute value, the application web root value is combined with this value to construct an absolute URL. This value is inserted into the transformation to provide the form's submit-to location. The form's data is posted to this URL. A client application must provide an implementation (for example, a Java servlet) at this location and the posted data can be retrieved using the processFormSubmission() method.

Returns:

A string value that specifies the URL to a web service or Java servlet that receives the posted data from a target device.

setTargetURL

public void setTargetURL(java.lang.String targetURL)

Sets a string value that specifies the URL to a web service or Java servlet that receives the posted data from a target device (typically, a web browser). This URL is inserted into the transformed output resulting in a submit operation invoking this URL. If not an absolute value, the application web root value is combined with this value to construct an absolute URL. This value is inserted into the transformation to provide the form's submit-to location. The form's data is posted to this URL. A client application must provide an implementation (for example, a Java servlet) at this location and the posted data can be retrieved using the processFormSubmission() method. You can submit a form to Workspace using the following URL: http://<server>:<port>/workspace-server/submit.

To see this method used in a code example, see the Rendering an interactive PDF form using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

targetURL - A string value that specifies the URL to a web service, Java servlet, or Workspace that receives the posted data from a target device.

getOptions

public java.lang.String getOptions()

For internal use only. Do not use.

Returns a string representation of the options that are set.

Returns:

A string representation of the options that are set.

getOption

public java.lang.String getOption(java.lang.String key)

Returns the value of the specified option.

Parameters:

key - A string value that specifies the name of the option.

Returns:

A string value that specifies the value of the option.

updateOptionsBean

public void updateOptionsBean(java.lang.String key,
                              java.lang.String value)

For internal purposes only. Do not invoke this method.

updateOptionsBean

public void updateOptionsBean(java.lang.String options)

For internal purposes only. Do not invoke this method.

toString

public java.lang.String toString()

For internal use only. Do not use.

Creates a string represenation of this class.

Overrides:

toString in class java.lang.Object

Returns:

A string represenation of this class.