com.novell.emframe.dev
Class eDirAccessService

java.lang.Object
  com.novell.nps.gadgetManager.BaseGadgetInstance
      com.novell.emframe.dev.Task
          com.novell.emframe.dev.eDirAccessService

All Implemented Interfaces:

com.novell.nps.configManager.ConfigurationComplete, com.novell.nps.gadgetManager.GadgetInstance, java.io.Serializable

public class eDirAccessService

extends Task

eDirector Access Service main task class. Plug-in Studio tasks are created with the eDirAccessService main task class. To do custom behavior, you will need to extend from eDirAccessService and overwrite the methods you need to do your custom work. You will also have to change the XML Descriptor that registers the task with iManager to point to your new class instead of eDirAccessService.

See Also:

Serialized Form

Field Summary

static java.lang.String	EDIR_AUX_KEY EDIR_AUX_KEY = "auxillaryClassExtension".
static java.lang.String	EDIR_COMMAND EDIR_COMMAND = "eDirCommand".
static java.lang.String	EDIR_CONNECTOR EDIR_CONNECTOR = "$".
static java.lang.String	EDIR_CREATE EDIR_CREATE = "create".
static java.lang.String	EDIR_KEY EDIR_KEY = "eDir$".
static java.lang.String	EDIR_READ EDIR_READ = "read".
static java.lang.String	EDIR_SEARCH EDIR_SEARCH = "eDirSearch".
static java.lang.String	EDIR_WRITE EDIR_WRITE = "write".
static java.lang.String	MODE_ADD MODE_ADD = "add".
static java.lang.String	MODE_IGN MODE_IGN = "ignore".
static java.lang.String	MODE_REM MODE_REM = "remove".
static java.lang.String	MODE_SET MODE_SET = "set".

Fields inherited from class com.novell.nps.gadgetManager.BaseGadgetInstance

CONFIGURABLE, gadgetAssignment, gadgetAssignmentDN, gadgetCode, gadgetInstanceID, GETDATA, HANDLE_ACTION_ERROR_STATE, helpURL, m_JSPDataObject, m_moduleStylesheet, m_previousState, myLocale, PROCESSREQUEST, repeatable, resBundle, session, state, STATE_SHOW_USER_CONFIG, STATE_USER_CONFIG_COMPLETE, windowState

Fields inherited from interface com.novell.nps.gadgetManager.GadgetInstance

FULLPAGE_BRANDING_AREA_MODE, FULLPAGE_DATA_MODE, FULLPAGE_REQUEST_PROPERTY, GADGET_DN, GADGET_INSTANCE_ARGS, GADGET_INSTANCE_CLASS, GADGET_INSTANCE_ID_PROPERTY, LAUNCH_TYPE_DELEGATE, LAUNCH_TYPE_LAUNCH, LIFECYCLE_TYPE_EXISTING, LIFECYCLE_TYPE_NEW, LIFECYCLE_TYPE_RECREATE, LIFECYCLE_TYPE_RESET, LIFECYCLE_TYPE_REUSE, PARAM_RETURN_STATUS, RETURN_STATUS_CANCEL, RETURN_STATUS_CANCEL_ABORT, RETURN_STATUS_CANCEL_CONTINUE, RETURN_STATUS_ERROR_ABORT, RETURN_STATUS_ERROR_CONTINUE, RETURN_STATUS_FINISHED, STATE_PROPERTY, TEXT_HTML, TEXT_XML, WINDOW_STATE_MAXIMIZED, WINDOW_STATE_MINIMIZED

Constructor Summary

eDirAccessService()

Method Summary

boolean	execute(TaskContext context, java.util.Properties resultStrings) Persistent API Method (used by book or tasking chaining to EDAS).
static java.lang.String	getEdasData(javax.servlet.http.HttpServletRequest req, java.lang.String key) Called by JSPConduit to get EDAS data from the request.
void	init(PluginContext context, org.jdom.Document doc) Initializes eDAS.
protected void	initialize(TaskContext context, org.jdom.Document doc) Called by eDirAccessSerivce.execute(...).
static boolean	isSyncableAttribute(java.lang.String attributeName) Returns whether a given attribute is syncable.
protected boolean	postCreate(TaskContext context, java.lang.String username) Override this method to do java work after EDAS creates the object in the execute method.
protected boolean	postRead(TaskContext context, java.util.Properties resultStrings) Override this method to do java work after EDAS reads the object in the execute method.
protected boolean	postWrite(java.util.Properties resultStrings, TaskContext context) Override this method to do java work after EDAS writes to the object in the execute method.
protected boolean	preCreate(java.lang.String username, TaskContext context) Override this method to do java work before EDAS creates the object in the execute method.
protected boolean	preRead(TaskContext context, java.util.Properties resultStrings) Override this method to do java work before EDAS reads the object in the execute method.
protected boolean	preWrite(TaskContext context, java.util.Properties resultStrings) Override this method to do java work before EDAS writes to the object in the execute method.
static void	shouldRun(javax.servlet.http.HttpServletRequest req, java.lang.String sServiceName) Returns whether this task should be able to run.

Methods inherited from class com.novell.emframe.dev.Task

buildQueryString, execute, execute, isInitialized, isPluginAvailable, release, setInitialized, setUIPage

Methods inherited from class com.novell.nps.gadgetManager.BaseGadgetInstance

addActionListener, callGetData, clearDocument, configureApply, configureCancel, configureComplete, createDocument, findURIForLocFile, getAction, getActionIcons, getAllowProcessRequestAsync, getConfig, getConfigObjectSetting, getConfigObjectSettings, getConfigSetting, getConfigSetting, getConfigSettings, getConfigSettingValue, getConfigSettingValues, getConfiguredUniqueID, getContainedGadgetInstanceStylesheets, getCustomizeQueryString, getData, getDataFromLastTry, getDocument, getFullPageMode, getGadgetAssignment, getGadgetAssignmentDN, getGadgetInstanceID, getGadgetXMLEndTag, getGadgetXMLStartTag, getHandleActionErrorStateData, getIntConfigSetting, getJSPDataObject, getJSPPage, getLangResourceURI, getLaunchType, getLifeCycleType, getLocale, getLocHelpURL, getLocResourceURI, getManagementServiceSet, getOriginalServiceName, getParam, getParentInstance, getPortalConnection, getPreferredDataType, getPreferredName, getPreferredName, getPrimary, getProxyServer, getRedirectionOrSelf, getRepeatParams, getResourceBundle, getResourcePathBase, getReturnStatus, getRootDelegator, getRootNodeName, getSession, getState, getStylesheetAndResourceSets, getStyleSheetName, getUserConfigCompleteData, getWindowState, handleAction, handlePostRequestActions, hasHelp, init, isConfigSettingCumulative, isConfigSettingOverwriteable, isForceRead, isTimedOut, onPageMaximize, onPageMinimize, onPortalInit, onShowUserConfigAction, onUserConfigCompleteAction, outputHTMLError, parseMultipartFormData, prepare, processRequest, processRequest, processSecondaryGadgetResults, removeActionListener, reset, returnToPrimary, setAllowProcessRequestAsync, setConfigSetting, setConfigSetting, setForceRead, setGadgetAssignment, setGadgetAssignmentDN, setGadgetInstanceID, setGetDataFromLastTry, setLaunchType, setLifeCycleType, setLocale, setModuleStylesheet, setParentInstance, setPrimary, setRedirectionOrSelf, setRepeatParams, setRequestedDataType, setResourceBundle, setRootDelegator, setSession, setState, setTimedOut, setWindowState, supportsDeviceCharacteristics, writeConfig, writeGadgetXMLEndTag, writeGadgetXMLStartTag

Methods inherited from class java.lang.Object

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

Field Detail

EDIR_AUX_KEY

public static final java.lang.String EDIR_AUX_KEY

EDIR_AUX_KEY = "auxillaryClassExtension".

See Also:

Constant Field Values

EDIR_COMMAND

public static final java.lang.String EDIR_COMMAND

EDIR_COMMAND = "eDirCommand".

See Also:

Constant Field Values

EDIR_CONNECTOR

public static final java.lang.String EDIR_CONNECTOR

EDIR_CONNECTOR = "$".

See Also:

Constant Field Values

EDIR_CREATE

public static final java.lang.String EDIR_CREATE

EDIR_CREATE = "create".

See Also:

Constant Field Values

EDIR_KEY

public static final java.lang.String EDIR_KEY

EDIR_KEY = "eDir$".

See Also:

Constant Field Values

EDIR_READ

public static final java.lang.String EDIR_READ

EDIR_READ = "read".

See Also:

Constant Field Values

EDIR_SEARCH

public static final java.lang.String EDIR_SEARCH

EDIR_SEARCH = "eDirSearch".

See Also:

Constant Field Values

EDIR_WRITE

public static final java.lang.String EDIR_WRITE

EDIR_WRITE = "write".

See Also:

Constant Field Values

MODE_ADD

public static final java.lang.String MODE_ADD

MODE_ADD = "add".

See Also:

Constant Field Values

MODE_IGN

public static final java.lang.String MODE_IGN

MODE_IGN = "ignore".

See Also:

Constant Field Values

MODE_REM

public static final java.lang.String MODE_REM

MODE_REM = "remove".

See Also:

Constant Field Values

MODE_SET

public static final java.lang.String MODE_SET

MODE_SET = "set".

See Also:

Constant Field Values

Constructor Detail

eDirAccessService

public eDirAccessService()

Method Detail

execute

public boolean execute(TaskContext context,
                       java.util.Properties resultStrings)

Persistent API Method (used by book or tasking chaining to EDAS).

Specified by:

execute in class Task

Parameters:

context - TaskContext of the plug-in

resultStrings - Properties objects that should be added to the HttpServletRequest

Returns:

boolean: true if execute was successful, false if otherwise

See Also:

Task.init(com.novell.emframe.dev.PluginContext, org.jdom.Document), Task.setUIPage(java.lang.String), PluginContext, eMFrameUtils

getEdasData

public static final java.lang.String getEdasData(javax.servlet.http.HttpServletRequest req,
                                                 java.lang.String key)

Called by JSPConduit to get EDAS data from the request.

Parameters:

req - The current HttpServletRequest

key - String containing the key to return the value for

Returns:

String containing the value of the key

init

public void init(PluginContext context,
                 org.jdom.Document doc)

Initializes eDAS.

Overrides:

init in class Task

Parameters:

context - PluginContext of the plug-in

doc - XML Document registering the plug-in

initialize

protected void initialize(TaskContext context,
                          org.jdom.Document doc)

Called by eDirAccessSerivce.execute(...). Needed request to support preview of task for custom handlers. Studio passes parameters on the request that are needed for initialization.

Parameters:

context - TaskContext of the plug-in

doc - XML Document registering the plug-in

isSyncableAttribute

public static final boolean isSyncableAttribute(java.lang.String attributeName)

Returns whether a given attribute is syncable.

Parameters:

attributeName - String containing the attribute name

Returns:

boolean: true if attribute is syncable, false if otherwise

postCreate

protected boolean postCreate(TaskContext context,
                             java.lang.String username)

Override this method to do java work after EDAS creates the object in the execute method.

Parameters:

username - String containing the username that was be created

context - TaskContext of the plug-in

Returns:

boolean: true if successful, false if otherwise

See Also:

preCreate(java.lang.String, com.novell.emframe.dev.TaskContext)

postRead

protected boolean postRead(TaskContext context,
                           java.util.Properties resultStrings)

Override this method to do java work after EDAS reads the object in the execute method.

Parameters:

context - TaskContext of the plug-in

resultStrings - Properties objects that should be added to the HttpServletRequest

Returns:

boolean: true if successful, false if otherwise

See Also:

preRead(com.novell.emframe.dev.TaskContext, java.util.Properties)

postWrite

protected boolean postWrite(java.util.Properties resultStrings,
                            TaskContext context)

Override this method to do java work after EDAS writes to the object in the execute method.

Parameters:

context - TaskContext of the plug-in

resultStrings - Properties objects that should be added to the HttpServletRequest

Returns:

boolean: true if successful, false if otherwise

See Also:

preWrite(com.novell.emframe.dev.TaskContext, java.util.Properties)

preCreate

protected boolean preCreate(java.lang.String username,
                            TaskContext context)

Override this method to do java work before EDAS creates the object in the execute method.

Parameters:

username - String containing the username that will be created

context - TaskContext of the plug-in

Returns:

boolean: true if successful, false if otherwise

See Also:

postCreate(com.novell.emframe.dev.TaskContext, java.lang.String)

preRead

protected boolean preRead(TaskContext context,
                          java.util.Properties resultStrings)

Override this method to do java work before EDAS reads the object in the execute method.

Parameters:

context - TaskContext of the plug-in

resultStrings - Properties objects that should be added to the HttpServletRequest

Returns:

boolean: true if successful, false if otherwise

See Also:

postRead(com.novell.emframe.dev.TaskContext, java.util.Properties)

preWrite

protected boolean preWrite(TaskContext context,
                           java.util.Properties resultStrings)

Override this method to do java work before EDAS writes to the object in the execute method.

Parameters:

context - TaskContext of the plug-in

resultStrings - Properties objects that should be added to the HttpServletRequest

Returns:

boolean: true if successful, false if otherwise

See Also:

postWrite(java.util.Properties, com.novell.emframe.dev.TaskContext)

shouldRun

public static void shouldRun(javax.servlet.http.HttpServletRequest req,
                             java.lang.String sServiceName)
                      throws java.lang.Exception

Returns whether this task should be able to run.

Parameters:

req - HttpServletRequest

sServiceName - String containing the id of this task

Throws:

java.lang.Exception - if this task cannot run