|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.twss.platform.ServicePlatform
public class ServicePlatform
Provide public interfaces into the TWSS Service Platform,
so that new service implementations can be more easily developed.
In order to use the runtime context APIs correctly, the ServicePlatformHandler
must be included into the webservices.xml for each Web Service Implementation.
<handler>
<handler-name>ServicePlatformHandler</handler-name>
<handler-class>com.ibm.twss.platform.ServicePlatformHandler</handler-class>
</handler>
Constructor Summary | |
---|---|
ServicePlatform()
|
Method Summary | |
---|---|
static java.lang.String |
decrypt(java.lang.String string)
Decrypt the string in a manner consistent with the TWSS Password datatype. |
static java.lang.String |
encrypt(java.lang.String string)
Encrypt the string in a manner consistent with the TWSS Password datatype. |
static java.lang.String |
formatUsingText(java.lang.String[] variables,
java.lang.String text)
Format the message string by doing substitutions. |
static AdmissionControlInterface |
getAdmissionControlClient()
Get the Admission Control client. |
static java.lang.String |
getClusterName()
Get the current cluster name. |
static java.lang.String |
getCurrentApplicationName()
Get the current application name. |
static java.lang.Exception[] |
getExceptionsFromInitialization()
Get the list of exceptions that occurred during the ServicePlatformHandler processing. |
static FaultAlarmInterface |
getFaultAlarmClient()
Get the Fault Alarm client. |
static java.lang.String |
getGlobalTransactionID()
Retrieve the transaction ID from the Access Gateway Transaction ID Generation Mediation Primitive Design. |
static ServicePlatformLogger |
getLogger(java.lang.Class cls)
Creates a wrapped trace logger for use in logging information about class method execution. |
static java.lang.String |
getMessageFromBundle(java.lang.String bundleName,
java.lang.String msgId,
java.util.Locale locale)
Get a message from the locale specific messages file in the resource bundle. |
static NetworkResourceInterface |
getNetworkResourceClient()
Get the Network Resource client. |
static NotificationRegistration |
getNoticationManagementRegistrationClient()
Get the Notification Registration client. |
static int |
getOperationTargets()
Retrieve the operationTargets per the Access Gateway Group Resolution Mediation Primitive Design. |
static java.lang.String[] |
getPolicies()
Retrieve a Set containing all of the policy names found in the incoming policy headers per the Policy/Subscription Mediation Primitive Design. |
static java.lang.String |
getPolicy(java.lang.String policyName)
Retrieve the value of the policy with the given name per the Policy/Subscription Mediation Primitive Design. |
static PrivacyInterface |
getPrivacyClient()
Get the Privacy client. |
static CallDirection |
getPxNotificationCallDirectionClient()
Get the PxNotification Call Direction Notification client. |
static CallNotification |
getPxNotificationCallNotificationClient()
Get the PxNotification Call Notification client. |
static MessageNotification |
getPxNotificationMessageNotificationClient()
Get the PxNotification Message Notification client. |
static PresenceNotification |
getPxNotificationPresenceNotificationClient()
Get the PxNotification Presence Notification client. |
static SmsNotification |
getPxNotificationSmsNotificationClient()
Get the PxNotification Sms Notification client. |
static TerminalLocationNotification |
getPxNotificationTerminalLocationClient()
Get the PxNotification Terminal Location Notification client. |
static TerminalStatusNotification |
getPxNotificationTerminalStatusNotificationClient()
Get the PxNotification Terminal Status Notification client. |
static WAPPushNotification |
getPxNotificationWAPPushNotificationClient()
Get the PxNotification WAPPush Notification client. |
static java.lang.String |
getRequesterID()
Retrieve the requester's identity. |
static java.util.Locale |
getRequesterLocale()
Retrieve the requester's preferred Locale. |
static java.lang.String |
getRequestURL()
Retrieve the HTTP request URL that the client used to access this operation. |
static java.lang.String[] |
getResolvedGroupURI(java.lang.String groupUri)
Retrieve a the members of the group with the given groupUri. |
static java.lang.String[] |
getResolvedGroupURIs()
Retrieve a Array of Strings with all of the unique group URIs found by the Group Resolution Mediation Primitive. |
static java.lang.String |
getSubstitutedMessage(java.lang.String bundleName,
java.lang.String messageId,
java.util.Locale locale,
java.lang.String text,
java.lang.String[] variables)
Get a message with substituted variables. |
static TrafficShapingInterface |
getTrafficShapingClient()
Get the Traffic Shaping client. |
static UsageRecordInterface |
getUsageRecordClient()
Get the Usage Record Client. |
static void |
initializeStatsComponent(java.lang.String componentName)
Initialize the status instance object in the default group for the specified component. |
static void |
publishAverageStat(java.lang.String componentName,
int metricID,
long countValue)
Publish a count average statistic. |
static void |
publishCountStat(java.lang.String componentName,
int metricID,
long count)
Publish a simple count statistic. |
static void |
publishTimeStat(java.lang.String componentName,
int metricID,
long timeValue)
Publish a time average statistic. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ServicePlatform()
Method Detail |
---|
public static UsageRecordInterface getUsageRecordClient()
public static FaultAlarmInterface getFaultAlarmClient()
public static AdmissionControlInterface getAdmissionControlClient()
public static TrafficShapingInterface getTrafficShapingClient()
public static NetworkResourceInterface getNetworkResourceClient()
public static PrivacyInterface getPrivacyClient()
public static CallDirection getPxNotificationCallDirectionClient()
public static CallNotification getPxNotificationCallNotificationClient()
public static TerminalStatusNotification getPxNotificationTerminalStatusNotificationClient()
public static MessageNotification getPxNotificationMessageNotificationClient()
public static PresenceNotification getPxNotificationPresenceNotificationClient()
public static SmsNotification getPxNotificationSmsNotificationClient()
public static WAPPushNotification getPxNotificationWAPPushNotificationClient()
public static TerminalLocationNotification getPxNotificationTerminalLocationClient()
public static NotificationRegistration getNoticationManagementRegistrationClient()
public static java.lang.Exception[] getExceptionsFromInitialization()
public static java.lang.String getGlobalTransactionID()
public static int getOperationTargets()
public static java.lang.String getRequesterID()
com.ibm.websphere.security.auth.WSSubject
's
getCallerPrincipal()
method, that value is
overrides. If an identity is then found using incoming
requesterID headers from the Access Gateway in the
http://www.ibm.com/schema/twss/v1_0 XML namespace, that
value overrides.
This must be called during a web service request that has the ServicePlatformHandler defined.
public static java.util.Locale getRequesterLocale()
public static java.lang.String[] getResolvedGroupURIs()
public static java.lang.String[] getResolvedGroupURI(java.lang.String groupUri)
groupUri
- to retrieve.
public static java.lang.String getPolicy(java.lang.String policyName)
policyName
- whose value is of interest.
public static java.lang.String[] getPolicies()
public static java.lang.String getRequestURL()
HttpServletRequest.getRequestURL()
public static java.lang.String encrypt(java.lang.String string)
string
- the string
public static java.lang.String decrypt(java.lang.String string)
string
- the string
public static void initializeStatsComponent(java.lang.String componentName)
If the status instance is not initialized, it will be initialized on the first attempt to publish data to it.
A matching com.ibm.soa.common.utils.stats.Stats
componentName
- the componentName
public static void publishCountStat(java.lang.String componentName, int metricID, long count)
componentName
- the component NamemetricID
- the metric namecount
- the current count of somethingpublic static void publishTimeStat(java.lang.String componentName, int metricID, long timeValue)
componentName
- the component namemetricID
- the metric nametimeValue
- the valuepublic static void publishAverageStat(java.lang.String componentName, int metricID, long countValue)
componentName
- the component namemetricID
- the metric namecountValue
- public static ServicePlatformLogger getLogger(java.lang.Class cls)
cls
- The name of the class associated with this logger
public static java.lang.String getSubstitutedMessage(java.lang.String bundleName, java.lang.String messageId, java.util.Locale locale, java.lang.String text, java.lang.String[] variables)
The following elements in the variables String array are assigned:
If a message doesn't need the transaction id or component name, variable[0] and/or variable[1] can be set to null or to an empty string.
If the text is set to null or an empty string, the message text will be retrieved from the locale specific message file in the resource bundle. Returns a message with the placeholders filled in.
bundleName
- the resource bundle name stubmessageId
- the message idlocale
- the locale, null to use the default locale.text
- the text, null to get message text from the resource bundlevariables
- the substitution values
public static java.lang.String getMessageFromBundle(java.lang.String bundleName, java.lang.String msgId, java.util.Locale locale)
bundleName
- the name of the bundlemsgId
- the message IDlocale
- the locale
public static java.lang.String formatUsingText(java.lang.String[] variables, java.lang.String text)
variables
- the substitution variablestext
- the message text
public static java.lang.String getCurrentApplicationName()
public static java.lang.String getClusterName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |