Package com.axemble.vdoc.sdk.controllers

Class BaseController

java.lang.Object

com.axemble.vdoc.sdk.controllers.BaseController

All Implemented Interfaces:

com.axemble.vdp.ui.framework.files.TemporaryFileManager, com.axemble.vdp.ui.framework.foundation.controllers.ICustomController, com.axemble.vdp.utils.parameters.FileRecipient, com.axemble.vdp.utils.parameters.ParamsHandler

Direct Known Subclasses:

Dispatcher

public abstract class BaseController
extends Object
implements com.axemble.vdp.ui.framework.foundation.controllers.ICustomController, com.axemble.vdp.ui.framework.files.TemporaryFileManager

Author:

vlygeros

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BaseController.Result

Field Summary

Fields

Modifier and Type	Field	Description
static final Logger	LOGGER
static final String	STATUS_KEY_AUTH_FAILED
static final String	STATUS_KEY_CAS_NOT_ACTIVATED
static final String	STATUS_KEY_INTERNAL_ERROR
static final String	STATUS_KEY_ISSUER_NOT_AUTHORIZED
static final String	STATUS_KEY_LOGGED_OUT
static final String	STATUS_KEY_LOGIN_SUCCESS
static final String	STATUS_KEY_REDIRECT_TO_LOGOUT
static final String	STATUS_KEY_REDIRECT_TO_LOGOUT_REDIRECT_URL
static final String	STATUS_KEY_REDIRECT_TO_OPENID_PROVIDER
static final String	STATUS_KEY_SESSION_DOES_N0T_MATCH
static final String	STATUS_KEY_UNAUTHORIZED_IP_ADDRESS
static final String	STATUS_KEY_UNKNOWN_COMMAND

Fields inherited from interface com.axemble.vdp.utils.parameters.ParamsHandler

ERROR_EXCEED_ELEM_SIZE, ERROR_EXCEED_TOTAL_SIZE, ERROR_NOT_COMPLETED, ERROR_READ_FAILED, EXCEED_ELEM_NUMBER, NO_ERROR

Constructor Summary

Constructors

Constructor	Description
BaseController()

Method Summary

Modifier and Type	Method	Description
protected IExecutionContext	buildResponse(IExecutionContext ec, BaseController.Result result)
protected void	checkSecurity(IExecutionContext.IRequest request)
final com.axemble.vdp.utils.parameters.TempUploadFile	createTempFile(String originalName)
IExecutionContext	doProcess(IExecutionContext ec)
com.axemble.vdp.utils.parameters.FileRecipient	findFileRecipient(String name, String originalFileName)
com.axemble.vdp.utils.parameters.StringRecipient	findStringRecipient(String name)
com.axemble.vdp.utils.parameters.XmlRecipient	findXmlRecipient()
protected final Collection<IAttachment>	getAttachments()
protected final IDirectoryModule	getDirectoryModule()
long	getMaxFileSize()
protected final IPortalModule	getPortalModule()
protected final IProjectModule	getProjectModule()
protected final IWorkflowModule	getWorkflowModule()
protected final boolean	isAuthorized(IExecutionContext.IRequest request)	Check if the request is authorized.
void	loadComplete(int errorCode, String name, String originalFileName, long writeSize)
OutputStream	prepareLoad(String name, String originalFileName)
final void	removeTempFile(com.axemble.vdp.utils.parameters.TempUploadFile file)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.axemble.vdp.ui.framework.foundation.controllers.ICustomController

parseRequest

Field Details

LOGGER

public static final Logger LOGGER

STATUS_KEY_AUTH_FAILED

public static final String STATUS_KEY_AUTH_FAILED

See Also:

• Constant Field Values

STATUS_KEY_LOGIN_SUCCESS

public static final String STATUS_KEY_LOGIN_SUCCESS

See Also:

• Constant Field Values

STATUS_KEY_LOGGED_OUT

public static final String STATUS_KEY_LOGGED_OUT

See Also:

• Constant Field Values

STATUS_KEY_CAS_NOT_ACTIVATED

public static final String STATUS_KEY_CAS_NOT_ACTIVATED

See Also:

• Constant Field Values

STATUS_KEY_UNKNOWN_COMMAND

public static final String STATUS_KEY_UNKNOWN_COMMAND

See Also:

• Constant Field Values

STATUS_KEY_REDIRECT_TO_LOGOUT_REDIRECT_URL

public static final String STATUS_KEY_REDIRECT_TO_LOGOUT_REDIRECT_URL

See Also:

• Constant Field Values

STATUS_KEY_SESSION_DOES_N0T_MATCH

public static final String STATUS_KEY_SESSION_DOES_N0T_MATCH

See Also:

• Constant Field Values

STATUS_KEY_ISSUER_NOT_AUTHORIZED

public static final String STATUS_KEY_ISSUER_NOT_AUTHORIZED

See Also:

• Constant Field Values

STATUS_KEY_INTERNAL_ERROR

public static final String STATUS_KEY_INTERNAL_ERROR

See Also:

• Constant Field Values

STATUS_KEY_REDIRECT_TO_LOGOUT

public static final String STATUS_KEY_REDIRECT_TO_LOGOUT

See Also:

• Constant Field Values

STATUS_KEY_REDIRECT_TO_OPENID_PROVIDER

public static final String STATUS_KEY_REDIRECT_TO_OPENID_PROVIDER

See Also:

• Constant Field Values

STATUS_KEY_UNAUTHORIZED_IP_ADDRESS

public static final String STATUS_KEY_UNAUTHORIZED_IP_ADDRESS

See Also:

• Constant Field Values

Constructor Details

BaseController

public BaseController()

Method Details

getPortalModule

protected final IPortalModule getPortalModule()

Returns:

the portalModule

getDirectoryModule

protected final IDirectoryModule getDirectoryModule()

Returns:

the directoryModule

getProjectModule

protected final IProjectModule getProjectModule()

Returns:

the projectModule

getWorkflowModule

protected final IWorkflowModule getWorkflowModule()

Returns:

the workflowModule

doProcess

public IExecutionContext doProcess(IExecutionContext ec)
                            throws IOException

Specified by:

doProcess in interface com.axemble.vdp.ui.framework.foundation.controllers.ICustomController

Throws:

IOException

buildResponse

protected IExecutionContext buildResponse(IExecutionContext ec,
 BaseController.Result result)
                                   throws IOException

Throws:

IOException

checkSecurity

protected void checkSecurity(IExecutionContext.IRequest request)

Parameters:

request -

isAuthorized

protected final boolean isAuthorized(IExecutionContext.IRequest request)
                              throws IOException

Check if the request is authorized.

Parameters:

request - The request.

Returns:

true if the request is authorized, false otherwise.

Throws:

IOException

findFileRecipient

public com.axemble.vdp.utils.parameters.FileRecipient findFileRecipient(String name,
 String originalFileName)
                                                                 throws IOException

Specified by:

findFileRecipient in interface com.axemble.vdp.utils.parameters.ParamsHandler

Throws:

IOException

findStringRecipient

public com.axemble.vdp.utils.parameters.StringRecipient findStringRecipient(String name)
                                                                     throws IOException

Specified by:

findStringRecipient in interface com.axemble.vdp.utils.parameters.ParamsHandler

Throws:

IOException

findXmlRecipient

public com.axemble.vdp.utils.parameters.XmlRecipient findXmlRecipient()
                                                               throws IOException

Specified by:

findXmlRecipient in interface com.axemble.vdp.utils.parameters.ParamsHandler

Throws:

IOException

getMaxFileSize

public long getMaxFileSize()
                    throws IOException

Specified by:

getMaxFileSize in interface com.axemble.vdp.utils.parameters.FileRecipient

Throws:

IOException

prepareLoad

public OutputStream prepareLoad(String name,
 String originalFileName)
                         throws IOException

Specified by:

prepareLoad in interface com.axemble.vdp.utils.parameters.FileRecipient

Throws:

IOException

loadComplete

public void loadComplete(int errorCode,
 String name,
 String originalFileName,
 long writeSize)
                  throws IOException

Specified by:

loadComplete in interface com.axemble.vdp.utils.parameters.FileRecipient

Throws:

IOException

createTempFile

public final com.axemble.vdp.utils.parameters.TempUploadFile createTempFile(String originalName)
                                                                     throws IOException

Specified by:

createTempFile in interface com.axemble.vdp.ui.framework.files.TemporaryFileManager

Throws:

IOException

removeTempFile

public final void removeTempFile(com.axemble.vdp.utils.parameters.TempUploadFile file)
                          throws IOException

Specified by:

removeTempFile in interface com.axemble.vdp.ui.framework.files.TemporaryFileManager

Throws:

IOException

getAttachments

protected final Collection<IAttachment> getAttachments()