Oracle Communications Services Gatekeeper Java API Reference
7.0.0.1

E96578-01

com.bea.wlcp.wlng.api.edr.config
Class ConfigDescriptor

java.lang.Object
  extended bycom.bea.wlcp.wlng.api.edr.config.ConfigDescriptor
Direct Known Subclasses:
AlarmConfigDescriptor, CdrConfigDescriptor, EdrConfigDescriptor

public abstract class ConfigDescriptor
extends java.lang.Object

This class holds the information about the descriptor when reading the XML configuration file.


Field Summary
static java.lang.String ATTRIBUTE_CONJUNCTION
           
static java.lang.String CUSTOM_ATTRIBUTE
           
static java.lang.String CUSTOM_ATTRIBUTE_KEY
           
static java.lang.String CUSTOM_ATTRIBUTE_VALUE
           
static java.lang.String CUSTOM_REGEX_ATTRIBUTE
           
static java.lang.String FIELD_ID
           
static java.lang.String PART_DATA
           
static java.lang.String PART_FILTER
           
 
Constructor Summary
ConfigDescriptor()
          Constructor.
 
Method Summary
 void addDataAttribute(java.lang.String key, java.lang.String value)
           
 void addFilterAttribute(java.lang.String key, java.lang.String value)
          Adds the filter key/value pair of the element.
 void addFilterRegexAttribute(java.lang.String key, java.lang.String value)
          Adds the filter regex key/value pair of the element.
 void addSource(com.bea.wlcp.wlng.edr.config.ConfigDescriptorSource descriptorSource)
          Adds the filter source element ( or ).
 boolean canBeCached()
          Returns true if this descriptor can be cached.
 java.lang.String getDataAttribute(java.lang.String name)
           
 java.util.Map getFilterAttributes()
           
 java.util.Map getFilterRegexAttributes()
           
 long getIdentifier()
          Returns the identifier of the EDR.
 java.lang.String getIdentifierAsString()
          Returns the identifier of the EDR as a string.
 java.lang.String getName()
           
 int getPosition()
          Gets the position of this descriptor relative to its xml configuration file.
 java.util.List getSources()
           
 boolean isMatching(EdrData edr)
          Returns true if the EdrData is matching this descriptor, false otherwise.
 void setConjunction(java.lang.String conjunction)
          Relationship between conditions ("AND" or "OR", default: "OR").
 void setDataAttributes(org.xml.sax.Attributes attributes)
          Adds the data attribute.
 void setName(java.lang.String name)
          Set the name of the descriptor.
 void setPosition(int position)
          Sets the position of this descriptor relative to its xml configuration file.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ATTRIBUTE_CONJUNCTION

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

CUSTOM_ATTRIBUTE

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

CUSTOM_ATTRIBUTE_KEY

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

CUSTOM_ATTRIBUTE_VALUE

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

CUSTOM_REGEX_ATTRIBUTE

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

FIELD_ID

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

PART_DATA

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

PART_FILTER

public static final java.lang.String PART_FILTER
See Also:
Constant Field Values
Constructor Detail

ConfigDescriptor

public ConfigDescriptor()
Constructor.

Method Detail

addDataAttribute

public void addDataAttribute(java.lang.String key,
                             java.lang.String value)

addFilterAttribute

public void addFilterAttribute(java.lang.String key,
                               java.lang.String value)
Adds the filter key/value pair of the element.


addFilterRegexAttribute

public void addFilterRegexAttribute(java.lang.String key,
                                    java.lang.String value)
Adds the filter regex key/value pair of the element.


addSource

public void addSource(com.bea.wlcp.wlng.edr.config.ConfigDescriptorSource descriptorSource)
Adds the filter source element ( or ).


canBeCached

public boolean canBeCached()
Returns true if this descriptor can be cached.


getDataAttribute

public java.lang.String getDataAttribute(java.lang.String name)

getFilterAttributes

public java.util.Map getFilterAttributes()

getFilterRegexAttributes

public java.util.Map getFilterRegexAttributes()

getIdentifier

public final long getIdentifier()
Returns the identifier of the EDR.

Returns:
The identifier of the EDR.

getIdentifierAsString

public final java.lang.String getIdentifierAsString()
Returns the identifier of the EDR as a string.

Returns:
The identifier of the EDR as a string.

getName

public java.lang.String getName()

getPosition

public int getPosition()
Gets the position of this descriptor relative to its xml configuration file.


getSources

public java.util.List getSources()

isMatching

public boolean isMatching(EdrData edr)
Returns true if the EdrData is matching this descriptor, false otherwise.

Parameters:
edr - The EdrData object.
Returns:
true if the EdrData object matches this descriptor.

setConjunction

public void setConjunction(java.lang.String conjunction)
Relationship between conditions ("AND" or "OR", default: "OR").

Parameters:
conjunction - "AND" or "OR", default: "OR".

setDataAttributes

public void setDataAttributes(org.xml.sax.Attributes attributes)
Adds the data attribute.


setName

public void setName(java.lang.String name)
Set the name of the descriptor.

Parameters:
name - Name of the descriptor (for example, 'edr', 'alarm', or 'cdr').

setPosition

public void setPosition(int position)
Sets the position of this descriptor relative to its xml configuration file.


toString

public java.lang.String toString()

Oracle Communications Services Gatekeeper Java API Reference
7.0.0.1

E96578-01

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