Skip navigation links

Oracle Communications Services Gatekeeper Java API Reference
5.0

E21717-02

A C D E F I J K M N O P Q R S T W


A

AbstractManagedPlugin - class com.bea.wlcp.wlng.api.plugin.common.AbstractManagedPlugin.
Deprecated. Use instead ManagedPluginService. AbstractManagedPlugin is a helper class for implementing a PluginService. A plug-in that implements this interface will have one plug-in instance created if it registers any north or south interfaces.
AccountState - class com.bea.wlcp.wlng.api.account.AccountState.
Account state.
AddressRequestInfo - class com.bea.wlcp.wlng.api.plugin.AddressRequestInfo.
Request info that contain one or more addresses.
AlarmConfigDescriptor - class com.bea.wlcp.wlng.api.edr.config.AlarmConfigDescriptor.
This class contains a description of a particular alarm.
ApplicationAccount - interface com.bea.wlcp.wlng.api.account.ApplicationAccount.
A WLNG application account.
ApplicationGroup - interface com.bea.wlcp.wlng.api.account.ApplicationGroup.
 
ApplicationInstance - interface com.bea.wlcp.wlng.api.account.ApplicationInstance.
A WLNG user.
Attr - interface com.bea.wlcp.wlng.api.management.annotations.Attr.
 

C

CdrConfigDescriptor - class com.bea.wlcp.wlng.api.edr.config.CdrConfigDescriptor.
This class contains the description of a particular CDR.
ClusterHelper - class com.bea.wlcp.wlng.api.util.cluster.ClusterHelper.
Helper class for clustering.
CompletionBarrier - interface com.bea.wlcp.wlng.api.plugin.CompletionBarrier.
 
CompletionBarrierCallback - interface com.bea.wlcp.wlng.api.plugin.CompletionBarrierCallback.
 
ConfigDescriptor - class com.bea.wlcp.wlng.api.edr.config.ConfigDescriptor.
This class holds the information about the descriptor when reading the XML configuration file.
ConfigurationException - exception com.bea.wlcp.wlng.api.storage.configuration.ConfigurationException.
General configuration exception.
ConfigurationListener - interface com.bea.wlcp.wlng.api.storage.configuration.ConfigurationListener.
Configuration change listener interface.
ConfigurationStore - interface com.bea.wlcp.wlng.api.storage.configuration.ConfigurationStore.
Interface to configuration store.
ConfigurationStoreFactory - class com.bea.wlcp.wlng.api.storage.configuration.ConfigurationStoreFactory.
Configuration store factory.
Context - interface com.bea.wlcp.wlng.api.interceptor.Context.
Interface defining interceptor context.
ContextInfo - interface com.bea.wlcp.wlng.api.plugin.context.ContextInfo.
Interface defining a context information object that is used by a ContextTranslator to put values into the current RequestContext.
ContextKey - interface com.bea.wlcp.wlng.api.plugin.context.ContextKey.
This annotation is used to specify that an argument of a method is to be put into the current RequestContext under the key specified by the string in the argument of the annotation.
ContextMapperInfo - interface com.bea.wlcp.wlng.api.plugin.context.ContextMapperInfo.
Interface defining a ContextMapperInfo.
ContextTranslate - interface com.bea.wlcp.wlng.api.plugin.context.ContextTranslate.
This annotation is almost identical to ContextKey but it is used for "complex" argument that required some traversal to get the interesting values.
ContextTranslator - interface com.bea.wlcp.wlng.api.plugin.context.ContextTranslator.
This interface defines the method a context translator must implement.
CorrelatorRequestInfo - class com.bea.wlcp.wlng.api.plugin.CorrelatorRequestInfo.
Request info that contain one correlator.
CustomSlaManager - class com.bea.wlcp.wlng.api.sla.CustomSlaManager.
 

D

DenyPluginException - exception com.bea.wlcp.wlng.api.plugin.DenyPluginException.
Policy deny plug-in exception.
DeploymentException - exception com.bea.wlcp.wlng.api.plugin.common.DeploymentException.
Deployment error.
Description - interface com.bea.wlcp.wlng.api.management.annotations.Description.
This is the annotation to add descriptions to the mbean operations
DuplicateConfigException - exception com.bea.wlcp.wlng.api.storage.DuplicateConfigException.
Thrown to indicate the a duplicate storage configuration has been detected.
DuplicateIdPluginException - exception com.bea.wlcp.wlng.api.plugin.DuplicateIdPluginException.
Plug-in with same ID registered exception.
DuplicateKeyException - exception com.bea.wlcp.wlng.api.management.DuplicateKeyException.
The operation resulted in a duplicate key exception.

E

Edr - interface com.bea.wlcp.wlng.api.edr.Edr.
This annotation is used to mark all methods to be woven with EDR.
EdrConfigDescriptor - class com.bea.wlcp.wlng.api.edr.config.EdrConfigDescriptor.
This class contains a description of a particular EDR.
EdrConstants - interface com.bea.wlcp.wlng.api.edr.EdrConstants.
Interface containing the mandatory and most used optional key/value for the EdrData or RequestContext object.
EdrData - class com.bea.wlcp.wlng.api.edr.EdrData.
Class holding the Edr data.
EdrDataHelper - class com.bea.wlcp.wlng.api.edr.EdrDataHelper.
This class provides method to create default EdrData objects.
EdrFilter - class com.bea.wlcp.wlng.api.edr.filter.EdrFilter.
This class creates an EDR filter given an XML configuration file.
EdrFilterFactory - class com.bea.wlcp.wlng.api.edr.filter.EdrFilterFactory.
This class creates the default filters for edrs, alarms, cdrs, etc.
EdrManager - class com.bea.wlcp.wlng.api.edr.EdrManager.
Deprecated. replaced by EdrServiceFactory This class returns the singleton instance of the Edr Service.
EdrService - interface com.bea.wlcp.wlng.api.edr.EdrService.
The EDR service.
EdrServiceFactory - class com.bea.wlcp.wlng.api.edr.EdrServiceFactory.
This class returns the singleton instance of the Edr Service.
EntryFilter - interface com.bea.wlcp.wlng.api.storage.filter.EntryFilter.
Entry filter interface.
EntryIndexFilter - interface com.bea.wlcp.wlng.api.storage.filter.EntryIndexFilter.
Special filter that use indexes to speed up filter queries, but with fallback to filtering Map.Entry objects using the matches method instead of using filtering on the value object only.
EventChannel - interface com.bea.wlcp.wlng.api.event_channel.EventChannel.
This EventChannel utility service can be used to generate and recieve events in WLNG cluster.
EventChannelFactory - class com.bea.wlcp.wlng.api.event_channel.EventChannelFactory.
 
EventChannelListener - interface com.bea.wlcp.wlng.api.event_channel.EventChannelListener.
This interface is to be implemented in order to recieve events from the Event Channel utility service.
ExceptionStatistics - interface com.bea.wlcp.wlng.api.statistics.ExceptionStatistics.
 
ExternalInvocation - interface com.bea.wlcp.wlng.api.servicecorrelation.ExternalInvocation.
This interface needs to be implemented in case you would like to extend service correlation's ID functionality to the WebLogic Network Gatekeeper.
ExternalInvocationException - exception com.bea.wlcp.wlng.api.servicecorrelation.ExternalInvocationException.
Used to wrap errors that come from the ExternalInvocation implementation class.

F

Filter - interface com.bea.wlcp.wlng.api.storage.filter.Filter.
Filter interface.

I

IDFactory - class com.bea.wlcp.wlng.api.util.IDFactory.
Factory for getting IDs
IndexFilter - interface com.bea.wlcp.wlng.api.storage.filter.IndexFilter.
Special filter that use indexes to speed up filter queries.
IndexKey - interface com.bea.wlcp.wlng.api.storage.filter.IndexKey.
Index key used to index filter queries.
IndexKeyFactory - class com.bea.wlcp.wlng.api.storage.filter.IndexKeyFactory.
Index key factory.
IndexKeys - interface com.bea.wlcp.wlng.api.storage.filter.IndexKeys.
Combined index key used to index filter queries.
IndexKeysFactory - class com.bea.wlcp.wlng.api.storage.filter.IndexKeysFactory.
Index keys factory.
InputManagementException - exception com.bea.wlcp.wlng.api.management.InputManagementException.
This exception should be used when the 'user' has input a value that is faulty.
InstanceFactory - class com.bea.wlcp.wlng.api.util.InstanceFactory.
Common factory used to retrieve instances of for a given interface, class or abstract class.
InterceptionPoint - class com.bea.wlcp.wlng.api.interceptor.InterceptionPoint.
Indicates the available positions where the interceptors can be invoked.
Interceptor - interface com.bea.wlcp.wlng.api.interceptor.Interceptor.
Interface that must be implemented by an interceptor.
InterceptorManager - interface com.bea.wlcp.wlng.api.interceptor.InterceptorManager.
InterceptorManager interface.
InterceptorManagerFactory - class com.bea.wlcp.wlng.api.interceptor.InterceptorManagerFactory.
Factory to retrieve the InterceptorManager.
InterceptorManagerListener - interface com.bea.wlcp.wlng.api.interceptor.InterceptorManagerListener.
 
Internal - interface com.bea.wlcp.wlng.api.management.annotations.Internal.
 
InvalidAddressSchemaPluginException - exception com.bea.wlcp.wlng.api.plugin.InvalidAddressSchemaPluginException.
Invalid address schema plug-in exception.
InvalidInputValuePluginException - exception com.bea.wlcp.wlng.api.plugin.InvalidInputValuePluginException.
No available plug-in exception.
InvalidSubscriberContractException - exception com.bea.wlcp.wlng.spi.subscriberdata.InvalidSubscriberContractException.
Indicates that an invalid subscriber contract was attempted to be created.
InvalidTypeException - exception com.bea.wlcp.wlng.api.storage.configuration.InvalidTypeException.
Invalid type exception.

J

JMSConnector - class com.bea.wlcp.wlng.api.edr.jms.JMSConnector.
This class provides methods to create JMS session and topic to the Edr topic.
JMSListener - class com.bea.wlcp.wlng.api.edr.jms.JMSListener.
Root class used by all JMS listener.
JMSListener.TYPE - class com.bea.wlcp.wlng.api.edr.jms.JMSListener.TYPE.
Type of registration

K

KeyNotFoundException - exception com.bea.wlcp.wlng.api.management.KeyNotFoundException.
The operation could not find the specified key.

M

MBeanManager - class com.bea.wlcp.wlng.api.management.MBeanManager.
This is a proxy class for mbean registration

This is example code how to register into the mbean manager:

mbean = new MyMBeanImpl(); MBeanManager.registerMBean(mbean, MyMBean.class.getName(), serviceContext.getName(), serviceContext.getName());

Note: The instanceName and the displayName in the example above are the same, but does not necessarily have to be so.

ManagedPlugin - class com.bea.wlcp.wlng.api.plugin.ManagedPlugin.
Deprecated. Use instead ManagedPluginService. Managed plug-in class. Implemented by the plug-in to be able to register in the plug-in manager.
ManagedPluginInstance - interface com.bea.wlcp.wlng.api.plugin.ManagedPluginInstance.
An plugin-instance including it's lifecycle.
ManagedPluginService - interface com.bea.wlcp.wlng.api.plugin.ManagedPluginService.
Defines a plug-in service that each plug-in must implement.
ManagementException - exception com.bea.wlcp.wlng.api.management.ManagementException.
 
MapperInfo - interface com.bea.wlcp.wlng.api.plugin.context.MapperInfo.
This annotation is used to specify that an argument of a method should be registered in the ContextMapperInfo.
MethodReferenceType - class com.bea.wlcp.wlng.spi.subscriberdata.sla.MethodReferenceType.
Java class for methodReferenceType complex type.

N

NoActivePluginException - exception com.bea.wlcp.wlng.api.plugin.NoActivePluginException.
No available plug-in exception.
NoAvailablePluginException - exception com.bea.wlcp.wlng.api.plugin.NoAvailablePluginException.
No available plug-in exception.
NoContext - interface com.bea.wlcp.wlng.api.plugin.context.NoContext.
This annotation indicates that the method should not be woven by the context aspect.
NoCustomMatchPluginException - exception com.bea.wlcp.wlng.api.plugin.NoCustomMatchPluginException.
No available plug-in exception.
NoEdr - interface com.bea.wlcp.wlng.api.edr.NoEdr.
This annotation indicates that the method should not be woven by the EDR aspect.
NoRoutePluginException - exception com.bea.wlcp.wlng.api.plugin.NoRoutePluginException.
No available plug-in exception.
NoSuchIdPluginException - exception com.bea.wlcp.wlng.api.plugin.NoSuchIdPluginException.
No such ID plug-in exception.
NotInitializedException - exception com.bea.wlcp.wlng.api.storage.configuration.NotInitializedException.
Not initialized exception.

O

OAuthDenyException - exception com.bea.wlcp.wlng.api.plugin.OAuthDenyException.
This exception will be thrown when visiting a resource denied by Oauth.
ObjectNameConstants - class com.bea.wlcp.wlng.api.management.ObjectNameConstants.
Constants for the objectName Use LEVEL1_TYPE and LEVEL1_INSTANCE_NAME for level1 in the hierarchy Use similar format for subsequent levels
OptionalParam - interface com.bea.wlcp.wlng.api.management.annotations.OptionalParam.
 
OrbFactory - class com.bea.wlcp.wlng.api.corba.OrbFactory.
Factory for retrieving the ORB.

P

Param - interface com.bea.wlcp.wlng.api.management.annotations.Param.
This is an annotation to add descriptions to mbean parameters
Plugin - interface com.bea.wlcp.wlng.api.plugin.Plugin.
Plugin interface
PluginException - exception com.bea.wlcp.wlng.api.plugin.PluginException.
Generic plug-in exception.
PluginHolder - interface com.bea.wlcp.wlng.api.plugin.PluginHolder.
Holder for a plug-in type and the plug-in instance
PluginIDRequestInfo - class com.bea.wlcp.wlng.api.plugin.PluginIDRequestInfo.
RequestInfo that contains the plug-in ID.
PluginInstance - interface com.bea.wlcp.wlng.api.plugin.PluginInstance.
Defines a plug-in instance.
PluginInstanceFactory - interface com.bea.wlcp.wlng.api.plugin.PluginInstanceFactory.
Plugin instance factory creates instances of a plug-in.
PluginInstanceLifecycle - interface com.bea.wlcp.wlng.api.plugin.PluginInstanceLifecycle.
Defines the lifecycle for a plug-in instance.
PluginInterfaceHolder - class com.bea.wlcp.wlng.api.plugin.PluginInterfaceHolder.
Class holding the information about a plugin interface (north or south).
PluginNorth - interface com.bea.wlcp.wlng.api.plugin.PluginNorth.
North interface of plugin
PluginNorthCallback - interface com.bea.wlcp.wlng.api.plugin.PluginNorthCallback.
Application facing interface for async responses from plugin
PluginPool - interface com.bea.wlcp.wlng.api.plugin.PluginPool.
PluginPool is a collection of PluginInstance's.
PluginRetryException - exception com.bea.wlcp.wlng.api.plugin.PluginRetryException.
 
PluginService - interface com.bea.wlcp.wlng.api.plugin.PluginService.
Defines a plug-in service.
PluginServiceLifecycle - interface com.bea.wlcp.wlng.api.plugin.PluginServiceLifecycle.
Interface that defines the lifecycle of a plug-in.
PluginSouth - interface com.bea.wlcp.wlng.api.plugin.PluginSouth.
South interface of plugin
ProfileProvider - interface com.bea.wlcp.wlng.spi.subscriberdata.ProfileProvider.
Each profile provider is responsible for a group of subscribers identified by their URI Bulk operations allow the provider to optimize for multiple subscriber profile retrievals Date: Jan 15, 2008 Time: 3:28:19 PM

Q

Quota - class com.bea.wlcp.wlng.spi.subscriberdata.sla.Quota.
Java class for quota complex type.

R

Rate - class com.bea.wlcp.wlng.spi.subscriberdata.sla.Rate.
Java class for rate complex type.
ReferenceGroupType - class com.bea.wlcp.wlng.spi.subscriberdata.sla.ReferenceGroupType.
Java class for referenceGroupType complex type.
RegistrationIdentifierRequestInfo - class com.bea.wlcp.wlng.api.plugin.RegistrationIdentifierRequestInfo.
Request info that contain one registration identifier.
RequestContext - interface com.bea.wlcp.wlng.api.plugin.context.RequestContext.
Interface defining a RequestContext.
RequestContextManager - class com.bea.wlcp.wlng.api.plugin.context.RequestContextManager.
This class is used to create, get and remove the RequestContext object per thread.
RequestFactory - class com.bea.wlcp.wlng.api.plugin.RequestFactory.
The Request factory is used to perform traffic path specific processing before and after a request is processed in the plug-in.
RequestIdentifierRequestInfo - class com.bea.wlcp.wlng.api.plugin.RequestIdentifierRequestInfo.
Request info that contain one request identifier.
RequestInfo - class com.bea.wlcp.wlng.api.plugin.RequestInfo.
Plug-in request info used collect information about a specific application request.
RestrictAllType - class com.bea.wlcp.wlng.spi.subscriberdata.sla.RestrictAllType.
Java class for restrictAllType complex type.
RestrictionType - class com.bea.wlcp.wlng.spi.subscriberdata.sla.RestrictionType.
Java class for restrictionType complex type.

S

ServiceClassType - class com.bea.wlcp.wlng.spi.subscriberdata.sla.ServiceClassType.
Java class for serviceClassType complex type.
ServiceGroupType - class com.bea.wlcp.wlng.spi.subscriberdata.sla.ServiceGroupType.
Java class for serviceGroupType complex type.
ServiceInfo - class com.bea.wlcp.wlng.api.plugin.ServiceInfo.
This class contains the information about a service: - interfaces - methods per interface - arguments per method
ServiceInfoArgument - class com.bea.wlcp.wlng.api.plugin.ServiceInfoArgument.
This class describes the argument of a method of an interface of a particular service type.
ServiceInfoInterface - class com.bea.wlcp.wlng.api.plugin.ServiceInfoInterface.
This class describes the interface of a particular service type.
ServiceInfoMethod - class com.bea.wlcp.wlng.api.plugin.ServiceInfoMethod.
This class describes the method of an interface of a particular service type.
ServiceProviderAccount - interface com.bea.wlcp.wlng.api.account.ServiceProviderAccount.
A WLNG service provider account.
ServiceProviderGroup - interface com.bea.wlcp.wlng.api.account.ServiceProviderGroup.
 
ServiceReferenceType - class com.bea.wlcp.wlng.spi.subscriberdata.sla.ServiceReferenceType.
Java class for serviceReferenceType complex type.
ServiceType - class com.bea.wlcp.wlng.api.plugin.ServiceType.
Abstract defining the service type that each plugin must use when registering in the plugin manager.
Sla - class com.bea.wlcp.wlng.spi.subscriberdata.sla.Sla.
Java class for anonymous complex type.
SlaParserCallback - interface com.bea.wlcp.wlng.api.sla.SlaParserCallback.
The call back class for cashing the SLA.
Statistics - interface com.bea.wlcp.wlng.api.statistics.Statistics.
 
StorageException - exception com.bea.wlcp.wlng.api.storage.StorageException.
Storage exception class.
Store - interface com.bea.wlcp.wlng.api.storage.Store.
Map based store interface used to put, get, remove Serializable objects.
StoreFactory - class com.bea.wlcp.wlng.api.storage.StoreFactory.
Store factory class.
StoreListener - interface com.bea.wlcp.wlng.api.storage.StoreListener.
Store listener interface.
StoreQuery - interface com.bea.wlcp.wlng.api.storage.StoreQuery.
Store query interface.
SubscriberContract - class com.bea.wlcp.wlng.spi.subscriberdata.SubscriberContract.
A SubscriberContract is a 'rate' and/or 'quota' restriciton for a given URI within a given ServiceClass until the specified expiration Date The subscriber contract supports rate and quota limits.
SubscriberDenyPluginException - exception com.bea.wlcp.wlng.api.plugin.SubscriberDenyPluginException.
Subscriber policy deny plug-in exception.
SubscriberSlaHelper - class com.bea.wlcp.wlng.spi.subscriberdata.sla.SubscriberSlaHelper.
 

T

TimerManagerFactory - class com.bea.wlcp.wlng.api.timers.TimerManagerFactory.
Factory for using the commonj.timers api.

W

WLNGMBeanDelegate - class com.bea.wlcp.wlng.api.management.WLNGMBeanDelegate.
 
WacOAuthClientAppAuthenticationException - exception com.bea.wlcp.wlng.api.plugin.WacOAuthClientAppAuthenticationException.
Put this exception class here because this exception class will be shared between WAC specified application ear and separated common interceptor ears for client application user lock out.
WorkManagerFactory - class com.bea.wlcp.wlng.api.work.WorkManagerFactory.
Factory for using the commonj.work api.

A C D E F I J K M N O P Q R S T W

Oracle Communications Services Gatekeeper Java API Reference
5.0

E21717-02


Copyright © 2008, 2011, Oracle and/or its affiliates. All rights reserved.