Package com.adobe.xfa.protocol

Class SysProtocol

java.lang.Object

com.adobe.xfa.protocol.SysProtocol

All Implemented Interfaces:

Protocol

public class SysProtocol
extends java.lang.Object
implements Protocol

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.xfa.protocol.Protocol

Protocol.MultiPartDesc, Protocol.PostRsvp, Protocol.SectionDataOption, Protocol.SimplePostData, Protocol.TrustType

Constructor Summary

Constructors

Constructor	Description
SysProtocol()	The default c'tor -- instantiate a Protocol object.
SysProtocol(AuthenticationHandler authenticationHandler, java.net.URLStreamHandler urlStreamHandler)

Method Summary

Modifier and Type	Method	Description
java.io.InputStream	get(java.lang.String sUrl)	Method to get (download) a file designated by the given URL.
AuthenticationHandler	getAuthenticationHandler()	Gets this protocol's authentication handler.
java.net.URLStreamHandler	getURLStreamHandler()	Gets the protocol's URL stream handler.
boolean	isTrusted(java.lang.String sURL, Protocol.TrustType eTrustType, boolean bThrow)	Determines if the given URL can be trusted according to the given type of enforcement rule.
Protocol.PostRsvp	post(Protocol.SimplePostData oData, java.lang.String sUrl)	Method to post form data to a designated URL.
Protocol.PostRsvp	post(java.util.List<? extends Protocol.MultiPartDesc> oData, java.lang.String sUrl)	Virtual method to post form data to a designated URL.
void	put(java.io.InputStream iFile, java.lang.String sUrl)	Method to put (upload) memory to a designated URL.
void	put(java.lang.String sFileName, java.lang.String sUrl)	Method to put (upload) the given file to a file designated by the given URL.
java.lang.String	scheme()	Gets the protocol's scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

SysProtocol

public SysProtocol()

The default c'tor -- instantiate a Protocol object.

SysProtocol

public SysProtocol(AuthenticationHandler authenticationHandler,
                   java.net.URLStreamHandler urlStreamHandler)

Method Detail

get

public java.io.InputStream get(java.lang.String sUrl)

Method to get (download) a file designated by the given URL.

Specified by:

get in interface Protocol

Parameters:

sUrl - the URL to download.

Returns:

an InputStream that contains the downloaded data.

Throws:

ExFull - "Couldn't read/get data from '%s'." exception.

put

public void put(java.lang.String sFileName,
                java.lang.String sUrl)

Method to put (upload) the given file to a file designated by the given URL.

Specified by:

put in interface Protocol

Parameters:

sFileName - the file to upload.

sUrl - the name of the URL to upload to.

Throws:

ExFull - "stream implementation unavailable" exception.

put

public void put(java.io.InputStream iFile,
                java.lang.String sUrl)

Method to put (upload) memory to a designated URL. The Internet server targeted by the URL must obviously be configured to allow uploads.

Specified by:

put in interface Protocol

Parameters:

iFile - the InputStream to be uploaded to the URL.

sUrl - the name of the URL to upload memory to.

post

public Protocol.PostRsvp post(Protocol.SimplePostData oData,
                              java.lang.String sUrl)

Method to post form data to a designated URL. The targeted URL must obviously be designed to read the data posted.

Specified by:

post in interface Protocol

Parameters:

oData - a description of the data being posted to the URL.

sUrl - the name of the URL to post data to.

Returns:

The status and response from the Post as a PostRsvp object.

post

public Protocol.PostRsvp post(java.util.List<? extends Protocol.MultiPartDesc> oData,
                              java.lang.String sUrl)

Virtual method to post form data to a designated URL. The targeted URL must obviously be designed to read the data posted.

Specified by:

post in interface Protocol

Parameters:

oData - a description of the data being posted to the URL.

sUrl - the name of the URL to post data to.

Returns:

The status and response from the Post as a PostRsvp object

getAuthenticationHandler

public AuthenticationHandler getAuthenticationHandler()

Gets this protocol's authentication handler.

Specified by:

getAuthenticationHandler in interface Protocol

Returns:

an AuthenticationHandler, or null.

getURLStreamHandler

public java.net.URLStreamHandler getURLStreamHandler()

Description copied from interface: Protocol

Gets the protocol's URL stream handler. This method is required for all implementations of custom protocols and must return a non-null value.

Specified by:

getURLStreamHandler in interface Protocol

Returns:

an URL stream handler.

isTrusted

public boolean isTrusted(java.lang.String sURL,
                         Protocol.TrustType eTrustType,
                         boolean bThrow)

Description copied from interface: Protocol

Determines if the given URL can be trusted according to the given type of enforcement rule.

Specified by:

isTrusted in interface Protocol

Parameters:

sURL - the URL to be trusted.

eTrustType - the type of trust enforcement needed.

bThrow - when true, requests that a trust exception (ExFull) be thrown if the URL is not trusted.

Returns:

true if trusted, otherwise false.

scheme

public java.lang.String scheme()

Description copied from interface: Protocol

Gets the protocol's scheme. This method is required for all implementations of custom protocols and must return a non-null, non-empty value.

Specified by:

scheme in interface Protocol

Returns:

this protocol's scheme.