Package com.adobe.livecycle.formsservice.client
Classpublic class URLSpec
InheritanceURLSpec Inheritance Object

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:


Public Methods
 MethodDefined by
  
URLSpec()
A standard constructor.
URLSpec
  
URLSpec(String optionsString)
A constructor that enables you to specify a standard query string.
URLSpec
  
URLSpec(String applicationWebRoot, String targetURL, String contentRootURI, String baseURL)
A constructor that enables you to set all options.
URLSpec
  
String getApplicationWebRoot()
Returns the application's web root.
URLSpec
  
String getBaseURL()
Returns a string value that represents the base URL.
URLSpec
  
String getContentRootURI()
Returns a string value that specifies a URI or an absolute reference to a location from which forms are retrieved.
URLSpec
  
String getOption(String key)
Returns the value of the specified option.
URLSpec
  
String getOptions()
For internal use only.
URLSpec
  
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).
URLSpec
  
void setApplicationWebRoot(String applicationWebRoot)
Sets the application's web root.
URLSpec
  
void setBaseURL(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.
URLSpec
  
void setContentRootURI(String contentRootURI)
Sets the URI value or an absolute reference to a location from which forms are retrieved.
URLSpec
  
void setTargetURL(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).
URLSpec
  
String toString()
For internal use only.
URLSpec
  
void updateOptionsBean(String key, String value)
For internal purposes only.
URLSpec
  
void updateOptionsBean(String options)
For internal purposes only.
URLSpec
Constructor Detail
URLSpec()
public URLSpec()

A standard constructor.

URLSpec() 
public URLSpec(String optionsString)

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

Parameters
optionsString
URLSpec() 
public URLSpec(String applicationWebRoot, String targetURL, String contentRootURI, String baseURL)

A constructor that enables you to set all options.

Parameters
applicationWebRoot
 
targetURL
 
contentRootURI
 
baseURL
Method Detail
getApplicationWebRoot()
public 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.
getBaseURL() 
public 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()
getContentRootURI() 
public 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()
getOption() 
public String getOption(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.
getOptions() 
public 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.
getTargetURL() 
public 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.
setApplicationWebRoot() 
public void setApplicationWebRoot(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.

Parameters

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

setBaseURL() 
public void setBaseURL(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()
setContentRootURI() 
public void setContentRootURI(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://.

Parameters

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

See also

setContentRootURI()
setTargetURL() 
public void setTargetURL(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.

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.

toString() 
public String toString()

For internal use only. Do not use.

Creates a string represenation of this class.

Returns
A string represenation of this class.
updateOptionsBean() 
public void updateOptionsBean(String key, String value)

For internal purposes only. Do not invoke this method.

Parameters

key
 
value

updateOptionsBean() 
public void updateOptionsBean(String options)

For internal purposes only. Do not invoke this method.

Parameters

options




© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Sep 27 2007, 8:38 AM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/livecycle/formsservice/client/URLSpec.html