org.rhq.modules.plugins.jbossas7

Class ASUploadConnection

java.lang.Object

org.rhq.modules.plugins.jbossas7.ASUploadConnection

public class ASUploadConnection
extends Object

Connection for uploading of content. This class needs to cache the content to be uploaded. Users of this class should:

1. Call getOutputStream() an write their content to the returned OutputStream
2. Call finishUpload() to actually upload the content

As instances of this class held some resources it is the caller responsibility to call cancelUpload() instead of finishUpload() if, for example, an IOException occured while writing their content to the OutputStream. Original code taken from https://github.com/jbossas/jboss-as/blob/master/testsuite/smoke/src/test/java/org/jboss/as/test/surefire/servermodule/HttpDeploymentUploadUnitTestCase.java

Author:

Jonathan Pearlin (of the original code), Heiko W. Rupp, Thomas Segismont

Constructor Summary

Constructors

Constructor and Description
ASUploadConnection(ASConnection asConnection) Deprecated. as of 4.6. This class is not reusable so there is no reason not to provide the filename to the constructor. Use {@link #ASUploadConnection(ASConnection, String) instead.
ASUploadConnection(ASConnection asConnection, String fileName) Creates a new ASUploadConnection from an existing ASConnection.
ASUploadConnection(String host, int port, String user, String password) Deprecated. as of 4.6. This class is not reusable so there is no reason not to provide the filename to the constructor. Use ASUploadConnection(String, int, String, String, String) instead.
ASUploadConnection(String host, int port, String user, String password, String fileName) Creates a new ASUploadConnection for a remote http management interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelUpload() To be called instead of finishUpload() if one doesn't want to upload the cached content.
org.codehaus.jackson.JsonNode	finishUpload() Triggers the real upload to the AS7 instance.
static String	getFailureDescription(org.codehaus.jackson.JsonNode jsonNode) Inspects the supplied JsonNode instance and returns the json 'failure-description' node value as text.
OutputStream	getOutputStream() Gives an outpustream where callers should write the content which will be uploaded to AS7 when finishUpload() will be called.
OutputStream	getOutputStream(String fileName) Deprecated. as of 4.6. Instances of this class should be created with fileName supplied to the constructor. If the caller does that there is no reason for late initialization of fileName. Then use getOutputStream() instead.
int	getTimeout() Get the currently active upload timeout
static boolean	isErrorReply(org.codehaus.jackson.JsonNode jsonNode) Inspects the supplied JsonNode instance to determine if it represents an error outcome.
static ASUploadConnection	newInstanceForServerPluginConfiguration(ServerPluginConfiguration pluginConfig, String fileName) This factory method simplifies creation of a new ASUploadConnection instance given the caller has access to the ServerPluginConfiguration.
void	setTimeout(int timeout) Set upload timeout in seconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

ASUploadConnection

@Deprecated
public ASUploadConnection(String host,
                             int port,
                             String user,
                             String password)

Deprecated. as of 4.6. This class is not reusable so there is no reason not to provide the filename to the constructor. Use ASUploadConnection(String, int, String, String, String) instead.

ASUploadConnection

public ASUploadConnection(String host,
                  int port,
                  String user,
                  String password,
                  String fileName)

Creates a new ASUploadConnection for a remote http management interface. If null user or password is given, this instance will not be able to reply to an authentication challenge. It's the responsibility of the caller to make sure either finishUpload() or cancelUpload() will be called to free resources this class helds.

Parameters:

host - - hostname of the remote http management interface

port - - port of the remote http management interface

user - - username to logon with to the remote http management interface.

password - - password to logon with to the remote http management interface

fileName - - fileName of the content (to provide in multipart post request)

ASUploadConnection

@Deprecated
public ASUploadConnection(ASConnection asConnection)

Deprecated. as of 4.6. This class is not reusable so there is no reason not to provide the filename to the constructor. Use {@link #ASUploadConnection(ASConnection, String) instead.

ASUploadConnection

public ASUploadConnection(ASConnection asConnection,
                  String fileName)

Creates a new ASUploadConnection from an existing ASConnection. This constructor has the same requirements as ASUploadConnection(String, int, String, String, String) which it uses internally.

Parameters:

asConnection - - existing ASConnection instance

fileName - - fileName of the content (to provide in multipart post request)

Method Detail

newInstanceForServerPluginConfiguration

public static ASUploadConnection newInstanceForServerPluginConfiguration(ServerPluginConfiguration pluginConfig,
                                                         String fileName)

This factory method simplifies creation of a new ASUploadConnection instance given the caller has access to the ServerPluginConfiguration.

Parameters:

pluginConfig - - the ServerPluginConfiguration

fileName - - fileName of the content (to provide in multipart post request)

Returns:

getOutputStream

@Deprecated
public OutputStream getOutputStream(String fileName)

Deprecated. as of 4.6. Instances of this class should be created with fileName supplied to the constructor. If the caller does that there is no reason for late initialization of fileName. Then use getOutputStream() instead.

getOutputStream

public OutputStream getOutputStream()

Gives an outpustream where callers should write the content which will be uploaded to AS7 when finishUpload() will be called.

Returns:

an OutputStream or null if it could not be created.

cancelUpload

public void cancelUpload()

To be called instead of finishUpload() if one doesn't want to upload the cached content. It's important to call this method if not actually uploading as it frees resources this class helds.

finishUpload

public org.codehaus.jackson.JsonNode finishUpload()

Triggers the real upload to the AS7 instance. At this point the caller should have written the content in the OutputStream given by getOutputStream().

Returns:

a JsonNode instance read from the upload response body or null if something went wrong.

getFailureDescription

public static String getFailureDescription(org.codehaus.jackson.JsonNode jsonNode)

Inspects the supplied JsonNode instance and returns the json 'failure-description' node value as text.

Parameters:

jsonNode -

Returns:

isErrorReply

public static boolean isErrorReply(org.codehaus.jackson.JsonNode jsonNode)

Inspects the supplied JsonNode instance to determine if it represents an error outcome.

Parameters:

jsonNode -

Returns:

getTimeout

public int getTimeout()

Get the currently active upload timeout

Returns:

timeout in seconds

setTimeout

public void setTimeout(int timeout)

Set upload timeout in seconds.

Parameters:

timeout - upload timeout in seconds