public final class UICommandFactory extends Object implements IFactoryInfoProvider, com.sap.netweaver.km.monitor.IMonitorInfoProvider, IClassLoaderRegistryListener
IFactoryInfoProvider.MappingInformation
Modifier and Type | Field and Description |
---|---|
static String |
KEY_ALIAS
Deprecated.
|
static String |
KEY_CLASS
Deprecated.
|
static String |
KEY_DESCRIPTION
Deprecated.
|
static String |
KEY_EMB_LABEL
Deprecated.
|
static String |
KEY_EMB_MASS_LABEL
Deprecated.
|
static String |
KEY_EMB_MASS_TOOLTIP
Deprecated.
|
static String |
KEY_EMB_TOOLTIP
Deprecated.
|
static String |
KEY_GROUP_BUNDLE_FILE
Deprecated.
|
static String |
KEY_GROUP_BUNDLE_LABEL
Deprecated.
|
static String |
KEY_GROUP_BUNDLE_TOOPTIP
Deprecated.
|
static String |
KEY_GROUP_COMMANDS_LIST
Deprecated.
|
static String |
KEY_GROUP_LABEL
Deprecated.
|
static String |
KEY_GROUP_TOOPTIP
Deprecated.
|
static String |
KEY_ICON_PATH
Deprecated.
|
static String |
KEY_INPUT_CONTROL_TEXT_1
Deprecated.
|
static String |
KEY_INPUT_CONTROL_TEXT_2
Deprecated.
|
static String |
KEY_LAYOUT_SET
Deprecated.
|
static String |
KEY_MASSCOMMAND
Deprecated.
|
static String |
KEY_PARAMETERS
Deprecated.
|
static String |
KEY_PROPERTIES
Deprecated.
|
static String |
KEY_ROLE_MAPPING
Deprecated.
|
static String |
LINE_BREAK
Deprecated.
constant used to separate debugging information
|
static ResourceBundles |
resBundleDefault
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
Boolean |
checkSecurity(IExecCommand command,
IResourceContext context)
Deprecated.
As of NetWeaver 7.1
|
void |
classLoaderAdded(String id,
ClassLoader newLoader)
Deprecated.
As of NetWeaver 7.1
|
void |
classLoaderReplaced(String id,
ClassLoader newLoader,
ClassLoader oldLoader)
Deprecated.
As of NetWeaver 7.1
|
ArrayList |
createTargetValues(IExecCommand command)
Deprecated.
As of NetWeaver 7.1
|
ArrayList |
createTargetValues(IMassExecCommand command)
Deprecated.
As of NetWeaver 7.1
|
IMassExecCommand |
decodeMassTarget(ArrayList values,
IResourceContext context,
IProxy proxy)
Deprecated.
As of NetWeaver 7.1
|
IExecCommand |
decodeTarget(ArrayList values,
IResourceContext context,
IProxy proxy)
Deprecated.
As of NetWeaver 7.1
|
IUIBaseCommand |
decodeTargetCommand(ArrayList values,
IResourceContext context,
IProxy proxy)
Deprecated.
As of NetWeaver 7.1
|
IUIBaseCommand |
getCommandByAlias(String alias,
IResourceContext context)
Deprecated.
As of NetWeaver 7.1
|
String |
getFactoryName()
Deprecated.
As of NetWeaver 7.1
|
IUIGroupCommand |
getGroupCommand(IResource resource,
IParameterName group,
IFlavor flavor,
Hashtable table)
Deprecated.
As of NetWeaver 7.1
|
IUIBaseCommand |
getGroupCommandByID(String groupID,
IResourceContext context)
Deprecated.
As of NetWeaver 7.1
|
static UICommandFactory |
getInstance()
Deprecated.
As of NetWeaver 7.1
|
long |
getLastReloadTime()
Deprecated.
As of NetWeaver 7.1
|
List |
getMappings(Locale locale)
Deprecated.
As of NetWeaver 7.1
|
List |
getPresentConfiguration(IResourceContext context)
Deprecated.
As of NetWeaver 7.1
|
String |
getPresentConfiguration(IResourceContext context,
String style,
boolean showJavaClassNames)
Deprecated.
As of NetWeaver 7.1
|
IPropertyNameList |
getRequiredProperties(String groupID)
Deprecated.
As of NetWeaver 7.1
|
String |
getScreenflowAlias(String commandalias)
Deprecated.
As of NetWeaver 7.1
|
IExecCommand |
getSingleCommandByAlias(String commandalias,
IResource res)
Deprecated.
As of NetWeaver 7.1
|
Status |
getStatus()
Deprecated.
As of NetWeaver 7.1
|
com.sap.netweaver.km.monitor.data.MonitorData |
retrieveMonitorData()
Deprecated.
Method that returns a MonitorData object with object infos to be displayed in KM Monitor
|
public static final String LINE_BREAK
public static final String KEY_ALIAS
public static final String KEY_CLASS
public static final String KEY_DESCRIPTION
public static final String KEY_ICON_PATH
public static final String KEY_MASSCOMMAND
public static final String KEY_ROLE_MAPPING
public static final String KEY_GROUP_COMMANDS_LIST
public static final String KEY_LAYOUT_SET
public static final String KEY_PROPERTIES
public static final String KEY_PARAMETERS
public static final String KEY_GROUP_LABEL
public static final String KEY_GROUP_TOOPTIP
public static final String KEY_GROUP_BUNDLE_LABEL
public static final String KEY_GROUP_BUNDLE_TOOPTIP
public static final String KEY_GROUP_BUNDLE_FILE
public static final String KEY_EMB_TOOLTIP
public static final String KEY_EMB_MASS_LABEL
public static final String KEY_EMB_MASS_TOOLTIP
public static final String KEY_EMB_LABEL
public static final String KEY_INPUT_CONTROL_TEXT_1
public static final String KEY_INPUT_CONTROL_TEXT_2
public static ResourceBundles resBundleDefault
public static UICommandFactory getInstance()
public String getScreenflowAlias(String commandalias)
InitialScreenflowProvider
technology. If an IExecCommand
implements the ISneakProvider
interface, this factory will retrieve the ScreenflowInformation
provided by
that class.commandalias
- the command to retrieve screenflow information for, must not be
null
.null
public IExecCommand getSingleCommandByAlias(String commandalias, IResource res)
commandalias
- the alias of the command to retrieve, must not be null
res
- the resource the command should use, must not be null
null
will be returned.public IUIBaseCommand getCommandByAlias(String alias, IResourceContext context)
IUIGroupCommand
with this alias exists, then if an IExecCommand
exists and finally, an IMassExecCommand
. If nothing can be found,
null
is returned and an error is added to the log file, stating
the alias searched for.alias
- the alias of the command requestedcontext
- the context of the current requestnull
public ArrayList createTargetValues(IExecCommand command) throws WcmException
IUICommand
to do its work. The ArrayList is used by the WdfEventDispatcher
to create the Component
that will trigger the execution of the
given command.command
- The command that has to rendered.ArrayList
a new ArrayList, with following
order position 0..n-1: The n-elements that are retrieved from the command
through its getTargetParameters
method position n: a UUID
to make sure that the created html-link will have a unique ID position
n+1: the alias of the IUICommand
, so the factory can recreate
an instance of this command when the decodeTarget
method is
called.WcmException
- Exception raised in failure situationpublic ArrayList createTargetValues(IMassExecCommand command) throws WcmException
IUIMassCommand
to do its work. The ArrayList is used by the WdfEventDispatcher
to create the Component
that will trigger the execution of the
given command.command
- The command that has to rendered.ArrayList
a new ArrayList, with following
order position 0..n-1: The n-elements that are retrieved from the command
through its getTargetParameters
method position n: a UUID
to make sure that the created html-link will have a unique ID position
n+1: the alias of the IUIMassCommand
, so the factory can recreate
an instance of this command when the decodeTarget
method is
called.WcmException
- Exception raised in failure situationpublic IUIBaseCommand decodeTargetCommand(ArrayList values, IResourceContext context, IProxy proxy) throws WcmException
IUICommand
as it was
encoded in the given array list by the factories createTarget
.
This command is ready to use, e.g. call its execute
method. It
can be used instead of the decodeTarget
or decodeMassTarget
methods, if it is unknown, which kind of class created the values list.values
- Description of the paramcontext
- Description of the paramproxy
- Description of the paramWcmException
- Exception raised in failure situationpublic IExecCommand decodeTarget(ArrayList values, IResourceContext context, IProxy proxy) throws WcmException
IUICommand
as it was
encoded in the given array list by the factories createTarget
.
This command is ready to use, e.g. call its execute
method.values
- a list of String
values, as it was created
by the createTargetValues
method of this class. Must not be
null
and must not contain classes that are not of type String
.context
- the present context of the session. Must not be null
.proxy
- the proxy that the returned command shall use. Must
not be null
IUICommand
which
was encoded in the values parameterWcmException
- Exception raised in failure situationpublic IMassExecCommand decodeMassTarget(ArrayList values, IResourceContext context, IProxy proxy) throws WcmException
IUIMassCommand
as it
was encoded in the given array list by the factories createTarget
. This command is ready to use, e.g. call its execute
method.values
- a list of String
values, as it was created
by the createTargetValues
method of this class. Must not be
null
and must not contain classes that are not of type String
.context
- the present context of the session. Must not be null
.proxy
- the proxy that the returned command shall use. Must
not be null
IUIMassCommand
which
was encoded in the values parameterWcmException
- Exception raised in failure situationpublic IUIGroupCommand getGroupCommand(IResource resource, IParameterName group, IFlavor flavor, Hashtable table) throws WcmException
IUIGroupCommand
can be found in the factories instances-table, null
is returnedresource
- the resource the group command is needed forflavor
- the flavor to use when reading the configurationgroup
- the parameter to look for in the configurationtable
- the parameters that hold configuration informationnull
WcmException
- Exception raised in failure situationpublic IUIBaseCommand getGroupCommandByID(String groupID, IResourceContext context)
groupID
- the groupID that is defined for the group command requested.context
- the current context of the sessionIUIGroupCommand
or null
, if no groupID was given or no group is defined for the given groupIDpublic String getPresentConfiguration(IResourceContext context, String style, boolean showJavaClassNames)
context
- the current context of the user, sets e.g. the language
of the labels for the commandsstyle
- currently not usedshowJavaClassNames
- flag to show (true) or hide (false) java class names
in the returned stringpublic List getPresentConfiguration(IResourceContext context)
String
to avoid ClassCastException
s.context
- Description of the parampublic List getMappings(Locale locale)
getMappings
in interface IFactoryInfoProvider
locale
- defines the language to use, if the factory offers translated information,
must not be null
IFactoryInfoProvider.MappingInformation
,
must not be null
public Status getStatus()
getStatus
in interface IFactoryInfoProvider
Status.ERROR
public String getFactoryName()
getFactoryName
in interface IFactoryInfoProvider
null
public IPropertyNameList getRequiredProperties(String groupID)
public com.sap.netweaver.km.monitor.data.MonitorData retrieveMonitorData()
retrieveMonitorData
in interface com.sap.netweaver.km.monitor.IMonitorInfoProvider
public long getLastReloadTime()
getLastReloadTime
in interface IFactoryInfoProvider
System.currentTimeMillis()
.
An implementing class might also return -1
to indicate, that
no information is available.public Boolean checkSecurity(IExecCommand command, IResourceContext context)
command
- context
- public void classLoaderAdded(String id, ClassLoader newLoader)
IClassLoaderRegistryListener
classLoaderAdded
in interface IClassLoaderRegistryListener
id
- the ID of the application being registered with CRTnewLoader
- the class loader of the applicationpublic void classLoaderReplaced(String id, ClassLoader newLoader, ClassLoader oldLoader)
IClassLoaderRegistryListener
classLoaderReplaced
in interface IClassLoaderRegistryListener
id
- the ID of the application being registered with CRTnewLoader
- the new class loaderoldLoader
- the old class loaderAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com]
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice