org.alfresco.repo.web.scripts

Class BaseWebScriptTest

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.alfresco.repo.web.scripts.BaseWebScriptTest

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

AbstractTestFormRestApi, AbstractWorkflowRestApiTest, AdminWebScriptTest, AssetTest, AuditWebScriptTest, BaseCMISTest, BlogServiceTest, CalendarRestApiTest, CommentsApiTest, DictionaryRestApiTest, DiscussionRestApiTest, DownloadRestApiTest, FeedControlTest, GroupsTest, InvitationWebScriptTest, InviteServiceTest, LinksRestApiTest, LoginTest, NodeArchiveServiceRestApiTest, NodeLocatorWebScriptTest, NodeWebScripTest, PersonSearchTest, PersonServiceTest, PreferenceServiceTest, PublishingRestApiTest, QuickShareRestApiTest, RatingRestApiTest, ReadOnlyTransactionInGetRestApiTest, RemoteAlfrescoTicketServiceTest, ReplicationRestApiTest, RepositoryContainerTest, RuleServiceTest, RunningActionRestApiTest, SandboxTest, SiteServiceTest, SOLRWebScriptTest, SubscriptionServiceRestApiTest, TaggingServiceTest, ThumbnailServiceTest, TransferWebScriptTest, WebProjectMembershipTest, WebProjectTest, WikiRestApiTest

public abstract class BaseWebScriptTest
extends junit.framework.TestCase

Base unit test class for web scripts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseWebScriptTest.BaseWebScriptTestListener Default Test Listener
static class	BaseWebScriptTest.HttpMethodResponse HttpMethod wrapped as Web Script Test Response
static class	BaseWebScriptTest.PatchMethod PATCH method
static class	BaseWebScriptTest.RemoteServer Remote Context
static interface	BaseWebScriptTest.WebScriptTestListener Web Script Test Listener

Constructor Summary

Constructors

Constructor and Description
BaseWebScriptTest()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.extensions.webscripts.servlet.ServletAuthenticatorFactory	getCustomAuthenticatorFactory() Returns the custom ServletAuthenticatorFactory which is injected into an TestWebScriptServer instances that are returned, if any.
java.lang.String	getDefaultRunAs() Get Default Local Run As User
BaseWebScriptTest.RemoteServer	getRemoteServer() Gets Remote Server
protected org.springframework.extensions.webscripts.TestWebScriptServer	getServer() Get the server for the previously-supplied custom context
protected boolean	isLogEnabled() Is Log Enabled?
protected void	log(java.lang.String log) Log Message to Test Listener
protected org.springframework.extensions.webscripts.TestWebScriptServer.Response	sendLocalRequest(org.springframework.extensions.webscripts.TestWebScriptServer.Request req, int expectedStatus, java.lang.String asUser) Send Local Request to Test Web Script Server
protected org.springframework.extensions.webscripts.TestWebScriptServer.Response	sendRemoteRequest(org.springframework.extensions.webscripts.TestWebScriptServer.Request req, int expectedStatus) Send Remote Request to stand-alone Web Script Server
protected org.springframework.extensions.webscripts.TestWebScriptServer.Response	sendRequest(org.springframework.extensions.webscripts.TestWebScriptServer.Request req, int expectedStatus) Send Request to Test Web Script Server (as admin)
protected org.springframework.extensions.webscripts.TestWebScriptServer.Response	sendRequest(org.springframework.extensions.webscripts.TestWebScriptServer.Request req, int expectedStatus, java.lang.String asUser) Send Request
void	setCustomAuthenticatorFactory(org.springframework.extensions.webscripts.servlet.ServletAuthenticatorFactory customAuthenticatorFactory) Sets that a custom ServletAuthenticatorFactory should be injected into instances of TestWebScriptServer returned from BaseWebScriptTest.getServer()
protected void	setCustomContext(java.lang.String customContext) Sets custom context for Test Web Script Server (in-process only)
void	setDefaultRunAs(java.lang.String localRunAs) Set Default Local Run As User
void	setListener(BaseWebScriptTest.WebScriptTestListener listener) Sets Test Listener
void	setRemoteServer(BaseWebScriptTest.RemoteServer server) Set Remote Server context
void	setTraceReqRes(boolean traceReqRes) Sets whether to trace request / response bodies
protected void	setUp()

Methods inherited from class junit.framework.TestCase

countTestCases, createResult, getName, run, run, runBare, runTest, setName, tearDown, toString

Methods inherited from class junit.framework.Assert

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, fail, fail, failNotEquals, failNotSame, failSame, format

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseWebScriptTest

public BaseWebScriptTest()

Method Detail

setCustomContext

protected void setCustomContext(java.lang.String customContext)

Sets custom context for Test Web Script Server (in-process only)

Parameters:

customContext -

setListener

public void setListener(BaseWebScriptTest.WebScriptTestListener listener)

Sets Test Listener

Parameters:

resultPrinter -

setTraceReqRes

public void setTraceReqRes(boolean traceReqRes)

Sets whether to trace request / response bodies

Parameters:

traceReqRes -

setRemoteServer

public void setRemoteServer(BaseWebScriptTest.RemoteServer server)

Set Remote Server context

Parameters:

server - remote server

getRemoteServer

public BaseWebScriptTest.RemoteServer getRemoteServer()

Gets Remote Server

Returns:

setDefaultRunAs

public void setDefaultRunAs(java.lang.String localRunAs)

Set Default Local Run As User

Parameters:

localRunAs -

getDefaultRunAs

public java.lang.String getDefaultRunAs()

Get Default Local Run As User

Returns:

localRunAs

getCustomAuthenticatorFactory

public org.springframework.extensions.webscripts.servlet.ServletAuthenticatorFactory getCustomAuthenticatorFactory()

Returns the custom ServletAuthenticatorFactory which is injected into an TestWebScriptServer instances that are returned, if any. Default is not to alter the ServletAuthenticatorFactory

setCustomAuthenticatorFactory

public void setCustomAuthenticatorFactory(org.springframework.extensions.webscripts.servlet.ServletAuthenticatorFactory customAuthenticatorFactory)

Sets that a custom ServletAuthenticatorFactory should be injected into instances of TestWebScriptServer returned from BaseWebScriptTest.getServer()

setUp

protected void setUp()
              throws java.lang.Exception

Overrides:

setUp in class junit.framework.TestCase

Throws:

java.lang.Exception

getServer

protected org.springframework.extensions.webscripts.TestWebScriptServer getServer()

Get the server for the previously-supplied custom context

isLogEnabled

protected boolean isLogEnabled()

Is Log Enabled?

Returns:

true => enabled

log

protected void log(java.lang.String log)

Log Message to Test Listener

Parameters:

log -

sendRequest

protected org.springframework.extensions.webscripts.TestWebScriptServer.Response sendRequest(org.springframework.extensions.webscripts.TestWebScriptServer.Request req,
                                                                                 int expectedStatus)
                                                                                      throws java.io.IOException

Send Request to Test Web Script Server (as admin)

Parameters:

req -

expectedStatus -

Returns:

response

Throws:

java.io.IOException

sendRequest

protected org.springframework.extensions.webscripts.TestWebScriptServer.Response sendRequest(org.springframework.extensions.webscripts.TestWebScriptServer.Request req,
                                                                                 int expectedStatus,
                                                                                 java.lang.String asUser)
                                                                                      throws java.io.IOException

Send Request

Parameters:

req -

expectedStatus -

asUser -

Returns:

response

Throws:

java.io.IOException

sendLocalRequest

protected org.springframework.extensions.webscripts.TestWebScriptServer.Response sendLocalRequest(org.springframework.extensions.webscripts.TestWebScriptServer.Request req,
                                                                                      int expectedStatus,
                                                                                      java.lang.String asUser)
                                                                                           throws java.io.IOException

Send Local Request to Test Web Script Server

Parameters:

req -

expectedStatus -

asUser -

Returns:

response

Throws:

java.io.IOException

sendRemoteRequest

protected org.springframework.extensions.webscripts.TestWebScriptServer.Response sendRemoteRequest(org.springframework.extensions.webscripts.TestWebScriptServer.Request req,
                                                                                       int expectedStatus)
                                                                                            throws java.io.IOException

Send Remote Request to stand-alone Web Script Server

Parameters:

req -

expectedStatus -

asUser -

Returns:

response

Throws:

java.io.IOException