Package org.alfresco.officeservices.testclient

Class AoservicesClient

java.lang.Object

org.alfresco.officeservices.testclient.AoservicesClient

public class AoservicesClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AoservicesClient.DialogType
class	AoservicesClient.FileStatus
class	AoservicesClient.FPSEGetDocsMetaInfo
class	AoservicesClient.FPSEUrlToWebUrl
class	AoservicesClient.FPSEVersion
static enum	AoservicesClient.LockState
static enum	AoservicesClient.OptionsHeaderValidation
static enum	AoservicesClient.VTI_INF_VERSION

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.http.client.CookieStore	cookieStore
protected org.apache.http.impl.client.DefaultHttpClient	httpClient
protected AoserviceClientMessageReceiver	messageReceiver
protected static URLEncoder	urlEncoder

Constructor Summary

Constructors

Constructor	Description
AoservicesClient(String username, String password)

Method Summary

Modifier and Type	Method	Description
void	addCookie(org.apache.http.cookie.Cookie cookie)
protected static boolean	arrayCompare(byte[] a1, byte[] a2)	Compares two byte arrays and returns true if and only if both are identical
protected void	checkForRequiredHeaders(org.apache.http.HttpResponse serviceResponse, boolean strict)	Checks the given HttpResponse for a set of required headers.
boolean	doHead(URI target)
protected void	emitMessage(String msg)
FPSEResponse	execute(FPSERequest request)	Execute the given FPSE request and return the response.
boolean	get(URI target)
org.dom4j.Document	getDocumentFromStream(InputStream is)
AoservicesClient.FileStatus	getFileStatusFromMetaInfo(FPSEResponseElement metaInfo)
AoservicesClient.FileStatus	getFPSECheckinDocument(URI serviceEndpoint, String fileUrl, String comment)
AoservicesClient.FileStatus	getFPSECheckoutDocument(URI serviceEndpoint, String fileUrl, int timeout)
AoservicesClient.FPSEGetDocsMetaInfo	getFPSEGetDocsMetaInfo(URI serviceEndpoint, List<String> targets)
AoservicesClient.FileStatus	getFPSEGetDocument(URI serviceEndpoint, String fileUrl)
FPSEResponseElement	getFPSEOpenService(URI serviceEndpoint)
AoservicesClient.FileStatus	getFPSEUncheckoutDocument(URI serviceEndpoint, String fileUrl, boolean rlsshortterm)
AoservicesClient.FPSEUrlToWebUrl	getFPSEUrlToWebUrl(URI target)
AoservicesClient.FPSEVersion	getFPSEVersion(URI target)
protected static String	getHeaderValue(org.apache.http.HttpResponse serviceResponse, String headerName, boolean strict)	Tries to get value from the last header with the given name.
protected FPSEResponseElement	getMandatoryElement(FPSEResponseElement elem, String name)
static byte[]	getResourceAsByteArray(String resource)	Returns a resource in the java ClassPath as byte array.
static InputStream	getResourceAsStream(String resource)	Returns a resource in the java ClassPath as stream.
AoservicesClient.VTI_INF_VERSION	getVtiInformation(URI target)
boolean	getWebForm(URI serviceEndpoint, String location, AoservicesClient.DialogType type, String filter)
String	lock(URI target, String currentLockToken)
boolean	options(URI target, AoservicesClient.OptionsHeaderValidation headerValidation)	Performs a OPTIONS request to the given target and returns true if and only if the resource exists.
boolean	propfind(URI target)	Performs a PROPFIND request to the given target and returns true if and only if the resource exists.
void	setMessageReceiver(AoserviceClientMessageReceiver receiver)
boolean	soapCheckin(URI serviceEndpoint, URI target, String comment)
boolean	soapCheckout(URI serviceEndpoint, URI target, boolean checkoutToLocal)
protected static byte[]	streamToByteArray(InputStream in)	Reads the contents in the input stream and returns it as byte array.
boolean	testWebFormExistence(URI serviceEndpoint, String location, AoservicesClient.DialogType type)
void	unlock(URI target, String currentLockToken)

Methods inherited from class java.lang.Object

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

Field Details

urlEncoder

protected static URLEncoder urlEncoder

httpClient

protected org.apache.http.impl.client.DefaultHttpClient httpClient

cookieStore

protected org.apache.http.client.CookieStore cookieStore

messageReceiver

protected AoserviceClientMessageReceiver messageReceiver

Constructor Details

AoservicesClient

public AoservicesClient(String username,
 String password)

Method Details

addCookie

public void addCookie(org.apache.http.cookie.Cookie cookie)

setMessageReceiver

public void setMessageReceiver(AoserviceClientMessageReceiver receiver)

emitMessage

protected void emitMessage(String msg)

getVtiInformation

public AoservicesClient.VTI_INF_VERSION getVtiInformation(URI target)
                                                   throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

options

public boolean options(URI target,
 AoservicesClient.OptionsHeaderValidation headerValidation)
                throws ServiceCommunicationException,
ServiceResponseException

Performs a OPTIONS request to the given target and returns true if and only if the resource exists.

Parameters:

target - the URI to test

Returns:

true if and only if the resource exists

Throws:

ServiceCommunicationException

ServiceResponseException

propfind

public boolean propfind(URI target)
                 throws ServiceCommunicationException,
ServiceResponseException

Performs a PROPFIND request to the given target and returns true if and only if the resource exists.

Parameters:

target - the URI to test

Returns:

true if and only if the resource exists

Throws:

ServiceCommunicationException

ServiceResponseException

lock

public String lock(URI target,
 String currentLockToken)
            throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

unlock

public void unlock(URI target,
 String currentLockToken)
            throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

execute

public FPSEResponse execute(FPSERequest request)
                     throws ServiceCommunicationException,
ServiceResponseException

Execute the given FPSE request and return the response.

Parameters:

request - the request to be executed

Returns:

the FPSE result

Throws:

ServiceCommunicationException

ServiceResponseException

getFPSEVersion

public AoservicesClient.FPSEVersion getFPSEVersion(URI target)
                                            throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

getFPSEUrlToWebUrl

public AoservicesClient.FPSEUrlToWebUrl getFPSEUrlToWebUrl(URI target)
                                                    throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

getFPSEOpenService

public FPSEResponseElement getFPSEOpenService(URI serviceEndpoint)
                                       throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

getFPSEGetDocsMetaInfo

public AoservicesClient.FPSEGetDocsMetaInfo getFPSEGetDocsMetaInfo(URI serviceEndpoint,
 List<String> targets)
                                                            throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

getFPSEGetDocument

public AoservicesClient.FileStatus getFPSEGetDocument(URI serviceEndpoint,
 String fileUrl)
                                               throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

getFPSECheckoutDocument

public AoservicesClient.FileStatus getFPSECheckoutDocument(URI serviceEndpoint,
 String fileUrl,
 int timeout)
                                                    throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

getFPSEUncheckoutDocument

public AoservicesClient.FileStatus getFPSEUncheckoutDocument(URI serviceEndpoint,
 String fileUrl,
 boolean rlsshortterm)
                                                      throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

getFPSECheckinDocument

public AoservicesClient.FileStatus getFPSECheckinDocument(URI serviceEndpoint,
 String fileUrl,
 String comment)
                                                   throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

getFileStatusFromMetaInfo

public AoservicesClient.FileStatus getFileStatusFromMetaInfo(FPSEResponseElement metaInfo)
                                                      throws ServiceResponseException

Throws:

ServiceResponseException

doHead

public boolean doHead(URI target)
               throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

testWebFormExistence

public boolean testWebFormExistence(URI serviceEndpoint,
 String location,
 AoservicesClient.DialogType type)
                             throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

getWebForm

public boolean getWebForm(URI serviceEndpoint,
 String location,
 AoservicesClient.DialogType type,
 String filter)
                   throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

get

public boolean get(URI target)
            throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

soapCheckout

public boolean soapCheckout(URI serviceEndpoint,
 URI target,
 boolean checkoutToLocal)
                     throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

soapCheckin

public boolean soapCheckin(URI serviceEndpoint,
 URI target,
 String comment)
                    throws ServiceCommunicationException,
ServiceResponseException

Throws:

ServiceCommunicationException

ServiceResponseException

getMandatoryElement

protected FPSEResponseElement getMandatoryElement(FPSEResponseElement elem,
 String name)
                                           throws ServiceResponseException

Throws:

ServiceResponseException

checkForRequiredHeaders

protected void checkForRequiredHeaders(org.apache.http.HttpResponse serviceResponse,
 boolean strict)
                                throws ServiceResponseException

Checks the given HttpResponse for a set of required headers. Throws ServiceResponseException if headers are missing or invalid.

Parameters:

serviceResponse - the HttpResponse to test

Throws:

ServiceResponseException - if headers are missing or invalid

getHeaderValue

protected static String getHeaderValue(org.apache.http.HttpResponse serviceResponse,
 String headerName,
 boolean strict)
                                throws ServiceResponseException

Tries to get value from the last header with the given name. Throws ServiceResponseException if header is not present.

Parameters:

serviceResponse - the response to get the header from

headerName - the name of the header

Returns:

the value from the last header with the given name

Throws:

ServiceResponseException - if header is not present

arrayCompare

protected static boolean arrayCompare(byte[] a1,
 byte[] a2)

Compares two byte arrays and returns true if and only if both are identical

Parameters:

a1 - the first array

a2 - the second array

Returns:

true if and only if both arrays are identical

streamToByteArray

protected static byte[] streamToByteArray(InputStream in)
                                   throws IOException

Reads the contents in the input stream and returns it as byte array.

Parameters:

in - The input stream containing the data

Returns:

the data from the input stream as byte array

Throws:

IOException

getResourceAsByteArray

public static byte[] getResourceAsByteArray(String resource)

Returns a resource in the java ClassPath as byte array.

Parameters:

resource - name of resource to load

Returns:

the byte array

getResourceAsStream

public static InputStream getResourceAsStream(String resource)

Returns a resource in the java ClassPath as stream.

Parameters:

resource - name of resource to load

Returns:

the stream

getDocumentFromStream

public org.dom4j.Document getDocumentFromStream(InputStream is)
                                         throws IOException,
org.dom4j.DocumentException

Throws:

IOException

org.dom4j.DocumentException