org.alfresco.filesys.alfresco
Class DesktopAction

java.lang.Object
  extended by org.alfresco.filesys.alfresco.DesktopAction
Direct Known Subclasses:
CheckInOutDesktopAction, CmdLineDesktopAction, EchoDesktopAction, JavaScriptDesktopAction, URLDesktopAction

public abstract class DesktopAction
extends java.lang.Object

Desktop Action Class


Field Summary
static int AttrAlfrescoFiles
           
static int AttrAlfrescoFolders
           
static int AttrAllowNoParams
           
static int AttrAnyFiles
           
static int AttrAnyFilesFolders
           
static int AttrAnyFolders
           
static int AttrClientFiles
           
static int AttrClientFolders
           
static int AttrMultiplePaths
           
static int AttrTargetFiles
           
static int AttrTargetFolders
           
protected static org.apache.commons.logging.Log logger
           
static int PreConfirmAction
           
static int PreCopyToTarget
           
static int PreLocalToWorkingCopy
           
static int StsAccessDenied
           
static int StsAuthTicket
           
static int StsBadParameter
           
static int StsCommandLine
           
static int StsError
           
static int StsFileNotFound
           
static int StsLaunchURL
           
static int StsNoSuchAction
           
static int StsNotWorkingCopy
           
static int StsSuccess
           
 
Constructor Summary
protected DesktopAction()
          Default constructor
protected DesktopAction(int attr, int preActions)
          Class constructor
protected DesktopAction(java.lang.String name)
          Class constructor
 
Method Summary
 boolean equals(java.lang.Object obj)
          Equality check
 int getAttributes()
          Return the desktop action attributes
 java.lang.String getConfirmationString()
          Return the action confirmation string to be displayed by the client application
 AlfrescoContext getContext()
          Return the filesystem context
 java.lang.String getName()
          Return the action name
 int getPreProcessActions()
          Return the desktop action pore-processing actions
 org.alfresco.jlan.server.filesys.pseudo.PseudoFile getPseudoFile()
          Return the associated pseudo file
 ServiceRegistry getServiceRegistry()
          Return the service registry
 java.lang.String getWebappURL()
          Return the webapp URL
 boolean hasAttribute(int attr)
          Check for a specified action attribute
 boolean hasDebug()
          Check if debug output is enabled
 boolean hasPreProcessAction(int pre)
          Check for the specified pre-process action
 boolean hasPseudoFile()
          Check if the action has an associated pseudo file
 boolean hasWebappURL()
          Check if the webapp URL is set
 void initializeAction(org.springframework.extensions.config.ConfigElement global, org.springframework.extensions.config.ConfigElement config, org.alfresco.jlan.server.filesys.DiskSharedDevice fileSys)
          Initialize the desktop action
 void initializeAction(ServiceRegistry serviceRegistry, AlfrescoContext filesysContext)
          Initialize the desktop action
abstract  DesktopResponse runAction(DesktopParams params)
          Run the desktop action
protected  void setAttributes(int attr)
          Set the action attributes
 void setDebug(boolean ena)
          Enable debug output
 void setFilename(java.lang.String filename)
          Set the associated pseudo file name
 void setName(java.lang.String name)
          Set the action name
 void setPath(java.lang.String path)
          Set the physical path of the associated pseudo file
 void setPreProcessActions(int pre)
          Set the client side pre-processing actions
 void setPseudoFile(org.alfresco.jlan.server.filesys.pseudo.PseudoFile pseudoFile)
          Set the associated pseudo file
 void setServiceRegistry(ServiceRegistry serviceRegistry)
           
 void setWebappURL(java.lang.String urlStr)
          Set the webapp URL
 void standardInitialize(org.springframework.extensions.config.ConfigElement global, org.springframework.extensions.config.ConfigElement config, org.alfresco.jlan.server.filesys.DiskSharedDevice fileSys)
          Perform standard desktop action initialization
 java.lang.String toString()
          Return the desktop action details as a string
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

logger

protected static final org.apache.commons.logging.Log logger

AttrTargetFiles

public static final int AttrTargetFiles
See Also:
Constant Field Values

AttrTargetFolders

public static final int AttrTargetFolders
See Also:
Constant Field Values

AttrClientFiles

public static final int AttrClientFiles
See Also:
Constant Field Values

AttrClientFolders

public static final int AttrClientFolders
See Also:
Constant Field Values

AttrAlfrescoFiles

public static final int AttrAlfrescoFiles
See Also:
Constant Field Values

AttrAlfrescoFolders

public static final int AttrAlfrescoFolders
See Also:
Constant Field Values

AttrMultiplePaths

public static final int AttrMultiplePaths
See Also:
Constant Field Values

AttrAllowNoParams

public static final int AttrAllowNoParams
See Also:
Constant Field Values

AttrAnyFiles

public static final int AttrAnyFiles
See Also:
Constant Field Values

AttrAnyFolders

public static final int AttrAnyFolders
See Also:
Constant Field Values

AttrAnyFilesFolders

public static final int AttrAnyFilesFolders
See Also:
Constant Field Values

PreCopyToTarget

public static final int PreCopyToTarget
See Also:
Constant Field Values

PreConfirmAction

public static final int PreConfirmAction
See Also:
Constant Field Values

PreLocalToWorkingCopy

public static final int PreLocalToWorkingCopy
See Also:
Constant Field Values

StsSuccess

public static final int StsSuccess
See Also:
Constant Field Values

StsError

public static final int StsError
See Also:
Constant Field Values

StsFileNotFound

public static final int StsFileNotFound
See Also:
Constant Field Values

StsAccessDenied

public static final int StsAccessDenied
See Also:
Constant Field Values

StsBadParameter

public static final int StsBadParameter
See Also:
Constant Field Values

StsNotWorkingCopy

public static final int StsNotWorkingCopy
See Also:
Constant Field Values

StsNoSuchAction

public static final int StsNoSuchAction
See Also:
Constant Field Values

StsLaunchURL

public static final int StsLaunchURL
See Also:
Constant Field Values

StsCommandLine

public static final int StsCommandLine
See Also:
Constant Field Values

StsAuthTicket

public static final int StsAuthTicket
See Also:
Constant Field Values
Constructor Detail

DesktopAction

protected DesktopAction()
Default constructor


DesktopAction

protected DesktopAction(int attr,
                        int preActions)
Class constructor

Parameters:
attr - int
preActions - int

DesktopAction

protected DesktopAction(java.lang.String name)
Class constructor

Parameters:
name - String
Method Detail

getAttributes

public final int getAttributes()
Return the desktop action attributes

Returns:
int

hasAttribute

public final boolean hasAttribute(int attr)
Check for a specified action attribute

Parameters:
attr - int
Returns:
boolean

getPreProcessActions

public final int getPreProcessActions()
Return the desktop action pore-processing actions

Returns:
int

hasPreProcessAction

public final boolean hasPreProcessAction(int pre)
Check for the specified pre-process action

Parameters:
pre - int
Returns:
boolean

getName

public final java.lang.String getName()
Return the action name

Returns:
String

hasPseudoFile

public final boolean hasPseudoFile()
Check if the action has an associated pseudo file

Returns:
boolean

getPseudoFile

public final org.alfresco.jlan.server.filesys.pseudo.PseudoFile getPseudoFile()
Return the associated pseudo file

Returns:
PseudoFile

getContext

public final AlfrescoContext getContext()
Return the filesystem context

Returns:
AlfrescoContext

getConfirmationString

public java.lang.String getConfirmationString()
Return the action confirmation string to be displayed by the client application

Returns:
String

getServiceRegistry

public final ServiceRegistry getServiceRegistry()
Return the service registry

Returns:
ServiceRegistry

setServiceRegistry

public final void setServiceRegistry(ServiceRegistry serviceRegistry)

hasDebug

public final boolean hasDebug()
Check if debug output is enabled

Returns:
boolean

hasWebappURL

public final boolean hasWebappURL()
Check if the webapp URL is set

Returns:
boolean

getWebappURL

public final java.lang.String getWebappURL()
Return the webapp URL

Returns:
String

initializeAction

public void initializeAction(org.springframework.extensions.config.ConfigElement global,
                             org.springframework.extensions.config.ConfigElement config,
                             org.alfresco.jlan.server.filesys.DiskSharedDevice fileSys)
                      throws DesktopActionException
Initialize the desktop action

Parameters:
global - ConfigElement
config - ConfigElement
fileSys - DiskSharedDevice
Throws:
DesktopActionException

standardInitialize

public void standardInitialize(org.springframework.extensions.config.ConfigElement global,
                               org.springframework.extensions.config.ConfigElement config,
                               org.alfresco.jlan.server.filesys.DiskSharedDevice fileSys)
                        throws DesktopActionException
Perform standard desktop action initialization

Parameters:
global - ConfigElement
config - ConfigElement
fileSys - DiskSharedDevice
Throws:
DesktopActionException

initializeAction

public void initializeAction(ServiceRegistry serviceRegistry,
                             AlfrescoContext filesysContext)
                      throws DesktopActionException
Initialize the desktop action

Throws:
DesktopActionException

runAction

public abstract DesktopResponse runAction(DesktopParams params)
                                   throws DesktopActionException
Run the desktop action

Parameters:
params - DesktopParams
Returns:
DesktopResponse
Throws:
DesktopActionException

setAttributes

protected final void setAttributes(int attr)
Set the action attributes

Parameters:
attr - int

setPreProcessActions

public final void setPreProcessActions(int pre)
Set the client side pre-processing actions

Parameters:
pre - int

setName

public final void setName(java.lang.String name)
Set the action name

Parameters:
name - String

setPseudoFile

public final void setPseudoFile(org.alfresco.jlan.server.filesys.pseudo.PseudoFile pseudoFile)
Set the associated pseudo file

Parameters:
pseudoFile - PseudoFile

setFilename

public void setFilename(java.lang.String filename)
Set the associated pseudo file name

Parameters:
filename - the file name

setPath

public void setPath(java.lang.String path)
Set the physical path of the associated pseudo file

Parameters:
path - the path

setDebug

public final void setDebug(boolean ena)
Enable debug output

Parameters:
ena - boolean

setWebappURL

public final void setWebappURL(java.lang.String urlStr)
Set the webapp URL

Parameters:
urlStr - String

equals

public boolean equals(java.lang.Object obj)
Equality check

Overrides:
equals in class java.lang.Object
Parameters:
obj - Object
Returns:
boolean

toString

public java.lang.String toString()
Return the desktop action details as a string

Overrides:
toString in class java.lang.Object
Returns:
String


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.