com.filenet.wcm.apps.server.util.integration
Class IntegrationUtil

java.lang.Object
  extended bycom.filenet.wcm.apps.server.util.integration.IntegrationUtil

public class IntegrationUtil
extends java.lang.Object


Nested Class Summary
protected static class IntegrationUtil.WindowIDTester
           
 
Field Summary
static java.lang.String AUTO_CONFIRM
           
static java.lang.String COMMAND_ID
           
static java.lang.String COMMAND_KEY
           
static java.lang.String COMMON_CLIENT_PREFIX
           
static java.lang.String CUSTOM_CSS
           
static java.lang.String DISMISS_LABEL
           
static java.lang.String MESSAGE
           
static java.lang.String REMOVE_ACTION
           
static java.lang.String REMOVE_BANNER
           
static java.lang.String REMOVE_FOOTER
           
static java.lang.String RESPONSE_KEY
           
static java.lang.String RESPONSE_URL
           
static java.lang.String RETURN_CODE
           
static java.lang.String THICK_CLIENT_PREFIX
           
static java.lang.String WEB_BASED_PREFIX
           
static java.lang.String WINDOW_TITLE
           
static com.filenet.wcm.toolkit.util.WcmString wsCommandCancelled
           
static com.filenet.wcm.toolkit.util.WcmString wsCommandCompleted
           
 
Constructor Summary
IntegrationUtil()
           
 
Method Summary
static ResponseCall createCancelledResponse(com.filenet.wcm.toolkit.server.base.WcmController controller)
           
static ResponseCall createResponseCall(com.filenet.wcm.toolkit.server.base.WcmController controller, java.util.Map parameters)
           
static java.lang.String decodeLabelParameter(java.lang.String key, java.lang.String value)
           
static java.lang.String encodeLabelParameter(java.lang.String key, java.lang.String value)
           
static CommandCall getCommandCall(com.filenet.wcm.toolkit.server.base.WcmController controller)
           
static java.lang.String getCommandKey(java.lang.String windowId)
           
static ResponseCall getResponseCall(com.filenet.wcm.toolkit.server.util.WcmDataStore ds, java.lang.String windowId)
           
static java.lang.String getResponseKey(java.lang.String windowId)
           
static java.lang.String getSingleParameter(java.util.Map parameters, java.lang.String key, boolean remove)
          Get a single string parameter from the parameter map.
static java.lang.String getURL(java.lang.String baseURLKey, java.lang.String url, WcmSitePrefs sitePrefs, com.filenet.wcm.toolkit.server.util.WcmDataStore dataStore)
           
static java.lang.String getWebBasedResponseURL(CommandCall command, int returnCode, java.lang.String message)
          Use for getting a generic response URL that does not contain command-specific parameters.
static boolean isClientSubWindow(java.lang.String windowId)
           
static boolean isClientSubWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)
           
static boolean isClientWindow(java.lang.String windowId)
           
static boolean isClientWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)
           
static boolean isThickClientWindow(java.lang.String windowId)
           
static boolean isThickClientWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)
           
static boolean isThickSubWindow(java.lang.String windowId)
           
static boolean isThickSubWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)
           
static boolean isWebBasedSubWindow(java.lang.String windowId)
           
static boolean isWebBasedSubWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)
           
static boolean isWebBasedWindow(java.lang.String windowId)
           
static boolean isWebBasedWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)
           
protected static void loadLabelParameters(com.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject prefs)
           
static void sendCancelledResponse(com.filenet.wcm.toolkit.server.base.WcmController controller)
           
static void sendCompletedResponse(com.filenet.wcm.toolkit.server.base.WcmController controller)
           
static void sendResponse(javax.servlet.http.HttpServletResponse resp, com.filenet.wcm.toolkit.server.base.WcmController controller, CommandCall command, ResponseCall responseCall)
           
static void sendResponse(javax.servlet.http.HttpServletResponse response, com.filenet.wcm.toolkit.server.base.WcmController controller, com.filenet.wcm.toolkit.server.util.FrameworkException e)
           
static void sendResponse(javax.servlet.http.HttpServletResponse resp, com.filenet.wcm.toolkit.server.base.WcmController controller, ResponseCall responseCall)
           
static void sendResponse(com.filenet.wcm.toolkit.server.base.WcmController controller, ResponseCall responseCall)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WEB_BASED_PREFIX

public static final java.lang.String WEB_BASED_PREFIX
See Also:
Constant Field Values

THICK_CLIENT_PREFIX

public static final java.lang.String THICK_CLIENT_PREFIX
See Also:
Constant Field Values

COMMON_CLIENT_PREFIX

public static final java.lang.String COMMON_CLIENT_PREFIX
See Also:
Constant Field Values

COMMAND_KEY

public static final java.lang.String COMMAND_KEY
See Also:
Constant Field Values

RESPONSE_KEY

public static final java.lang.String RESPONSE_KEY
See Also:
Constant Field Values

COMMAND_ID

public static final java.lang.String COMMAND_ID
See Also:
Constant Field Values

RESPONSE_URL

public static final java.lang.String RESPONSE_URL
See Also:
Constant Field Values

WINDOW_TITLE

public static final java.lang.String WINDOW_TITLE
See Also:
Constant Field Values

DISMISS_LABEL

public static final java.lang.String DISMISS_LABEL
See Also:
Constant Field Values

AUTO_CONFIRM

public static final java.lang.String AUTO_CONFIRM
See Also:
Constant Field Values

CUSTOM_CSS

public static final java.lang.String CUSTOM_CSS
See Also:
Constant Field Values

REMOVE_BANNER

public static final java.lang.String REMOVE_BANNER
See Also:
Constant Field Values

REMOVE_FOOTER

public static final java.lang.String REMOVE_FOOTER
See Also:
Constant Field Values

REMOVE_ACTION

public static final java.lang.String REMOVE_ACTION
See Also:
Constant Field Values

RETURN_CODE

public static final java.lang.String RETURN_CODE
See Also:
Constant Field Values

MESSAGE

public static final java.lang.String MESSAGE
See Also:
Constant Field Values

wsCommandCancelled

public static final com.filenet.wcm.toolkit.util.WcmString wsCommandCancelled

wsCommandCompleted

public static final com.filenet.wcm.toolkit.util.WcmString wsCommandCompleted
Constructor Detail

IntegrationUtil

public IntegrationUtil()
Method Detail

loadLabelParameters

protected static void loadLabelParameters(com.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject prefs)

isClientWindow

public static boolean isClientWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)

isThickClientWindow

public static boolean isThickClientWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)

isWebBasedWindow

public static boolean isWebBasedWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)

isClientWindow

public static boolean isClientWindow(java.lang.String windowId)

isClientSubWindow

public static boolean isClientSubWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)

isClientSubWindow

public static boolean isClientSubWindow(java.lang.String windowId)

isThickSubWindow

public static boolean isThickSubWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)

isThickSubWindow

public static boolean isThickSubWindow(java.lang.String windowId)

isThickClientWindow

public static boolean isThickClientWindow(java.lang.String windowId)

isWebBasedWindow

public static boolean isWebBasedWindow(java.lang.String windowId)

isWebBasedSubWindow

public static boolean isWebBasedSubWindow(com.filenet.wcm.toolkit.server.base.WcmController controller)

isWebBasedSubWindow

public static boolean isWebBasedSubWindow(java.lang.String windowId)

sendResponse

public static void sendResponse(com.filenet.wcm.toolkit.server.base.WcmController controller,
                                ResponseCall responseCall)
                         throws java.lang.Exception
Throws:
java.lang.Exception

sendResponse

public static void sendResponse(javax.servlet.http.HttpServletResponse resp,
                                com.filenet.wcm.toolkit.server.base.WcmController controller,
                                ResponseCall responseCall)
                         throws java.lang.Exception
Throws:
java.lang.Exception

sendResponse

public static void sendResponse(javax.servlet.http.HttpServletResponse resp,
                                com.filenet.wcm.toolkit.server.base.WcmController controller,
                                CommandCall command,
                                ResponseCall responseCall)
                         throws java.lang.Exception
Throws:
java.lang.Exception

getWebBasedResponseURL

public static java.lang.String getWebBasedResponseURL(CommandCall command,
                                                      int returnCode,
                                                      java.lang.String message)
Use for getting a generic response URL that does not contain command-specific parameters.

Parameters:
command -
returnCode -
message -
Returns:

sendCancelledResponse

public static void sendCancelledResponse(com.filenet.wcm.toolkit.server.base.WcmController controller)
                                  throws java.lang.Exception
Throws:
java.lang.Exception

createCancelledResponse

public static ResponseCall createCancelledResponse(com.filenet.wcm.toolkit.server.base.WcmController controller)
                                            throws java.lang.Exception
Throws:
java.lang.Exception

sendCompletedResponse

public static void sendCompletedResponse(com.filenet.wcm.toolkit.server.base.WcmController controller)
                                  throws java.lang.Exception
Throws:
java.lang.Exception

sendResponse

public static void sendResponse(javax.servlet.http.HttpServletResponse response,
                                com.filenet.wcm.toolkit.server.base.WcmController controller,
                                com.filenet.wcm.toolkit.server.util.FrameworkException e)
                         throws java.lang.Exception
Throws:
java.lang.Exception

getCommandCall

public static CommandCall getCommandCall(com.filenet.wcm.toolkit.server.base.WcmController controller)
                                  throws java.lang.Exception
Throws:
java.lang.Exception

getCommandKey

public static java.lang.String getCommandKey(java.lang.String windowId)

getResponseKey

public static java.lang.String getResponseKey(java.lang.String windowId)

getResponseCall

public static ResponseCall getResponseCall(com.filenet.wcm.toolkit.server.util.WcmDataStore ds,
                                           java.lang.String windowId)

createResponseCall

public static ResponseCall createResponseCall(com.filenet.wcm.toolkit.server.base.WcmController controller,
                                              java.util.Map parameters)
                                       throws java.lang.Exception
Throws:
java.lang.Exception

getSingleParameter

public static java.lang.String getSingleParameter(java.util.Map parameters,
                                                  java.lang.String key,
                                                  boolean remove)
Get a single string parameter from the parameter map.

Parameters:
parameters - - The parameters map.
key - - The key to get the String value for.
remove - - Specify "true" to remove the parameter as well.
Returns:

encodeLabelParameter

public static java.lang.String encodeLabelParameter(java.lang.String key,
                                                    java.lang.String value)

decodeLabelParameter

public static java.lang.String decodeLabelParameter(java.lang.String key,
                                                    java.lang.String value)

getURL

public static java.lang.String getURL(java.lang.String baseURLKey,
                                      java.lang.String url,
                                      WcmSitePrefs sitePrefs,
                                      com.filenet.wcm.toolkit.server.util.WcmDataStore dataStore)
                               throws java.lang.Exception
Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.