Cisco Systems Inc. Confidential

com.scms.common
Class SubscriberData

java.lang.Object
  extended by com.scms.common.SubscriberData
All Implemented Interfaces:
com.pcube.management.framework.rpc.GenericSerializable, java.io.Serializable

public class SubscriberData
extends java.lang.Object
implements java.io.Serializable, com.pcube.management.framework.rpc.GenericSerializable

See Also:
Serialized Form

Field Summary
static int MAX_SUBSCRIBER_NAME_LENGTH
           
 
Constructor Summary
SubscriberData(com.scms.common.ExtendedAttributes esa, java.lang.String subID, NetworkID netID, boolean isAdditive, PolicyProfile policy, com.scms.common.QuotaOperation quotaOperation)
          Constructor to support ExtendedAttributes for the subscriber in push mode
SubscriberData(com.scms.common.ExtendedAttributes esa, java.lang.String subID, java.lang.String anonID, NetworkID netID, boolean isAdditive, PolicyProfile policy, com.scms.common.QuotaOperation quotaOperation)
          Constructor to support ExtendedAttributes for the subscriber in pull mode
SubscriberData(com.scms.common.ExtendedAttributes esa, java.lang.String subID, java.lang.String anonID, NetworkID netID, boolean isAdditive, PolicyProfile policy, com.scms.common.QuotaOperation quotaOperation, com.scms.common.Quota quota)
          Constructor to support ExtendedAttributes for the subscriber
SubscriberData(java.lang.String subID)
           
SubscriberData(java.lang.String subID, NetworkID netID, boolean isAdditive)
           
SubscriberData(java.lang.String subID, NetworkID netID, boolean isAdditive, PolicyProfile policy, com.scms.common.QuotaOperation quotaOperation)
           
SubscriberData(java.lang.String subID, PolicyProfile policy)
           
SubscriberData(java.lang.String subID, com.scms.common.Quota quota)
           
SubscriberData(java.lang.String subID, com.scms.common.QuotaOperation quotaOperation)
           
SubscriberData(java.lang.String subID, java.lang.String anonID, NetworkID netID, boolean isAdditive, PolicyProfile policy, com.scms.common.QuotaOperation quotaOperation)
           
SubscriberData(java.lang.String subID, java.lang.String anonID, NetworkID netID, boolean isAdditive, PolicyProfile policy, com.scms.common.QuotaOperation quotaOperation, com.scms.common.Quota quota)
           
 
Method Summary
 void addNetworkID(java.lang.String mapping, short type)
           
static void checkSubscriberId(java.lang.String subscriberId, boolean allowNull)
          verifies the subscriber ID is legal
 boolean getAdditiveFlag()
          whether the network IDs should be added to the existing ones.
 java.lang.String getAnonymousID()
          the ID of the temporay subscriber which was created in the SCE.
 com.scms.common.ExtendedAttributes getExtendedAttributes()
          ExtendedAttributes of the subscriber
 java.lang.String[] getMappings()
          network Ids in string format
 java.lang.String[] getPolicyStrings()
          policy profile in string format (as used in the PolicyProfule constructor)
 java.lang.String[] getQuotaOperationStrings()
          Quota operation represented as strings
 java.lang.String[] getQuotaStrings()
          Quota represented as a string
 java.lang.String getSubscriberID()
          the subscriber's ID (name)
 short[] getTypes()
          network ID types
static com.scms.common.BufferUtils.GetResult readObject(byte[] buf, int pos)
           
 java.lang.String toString()
           
 int writeObject(byte[] buf, int pos)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MAX_SUBSCRIBER_NAME_LENGTH

public static final int MAX_SUBSCRIBER_NAME_LENGTH
See Also:
Constant Field Values
Constructor Detail

SubscriberData

public SubscriberData(java.lang.String subID,
                      com.scms.common.QuotaOperation quotaOperation)

SubscriberData

public SubscriberData(java.lang.String subID)

SubscriberData

public SubscriberData(java.lang.String subID,
                      com.scms.common.Quota quota)

SubscriberData

public SubscriberData(java.lang.String subID,
                      PolicyProfile policy)

SubscriberData

public SubscriberData(java.lang.String subID,
                      NetworkID netID,
                      boolean isAdditive)

SubscriberData

public SubscriberData(java.lang.String subID,
                      NetworkID netID,
                      boolean isAdditive,
                      PolicyProfile policy,
                      com.scms.common.QuotaOperation quotaOperation)

SubscriberData

public SubscriberData(java.lang.String subID,
                      java.lang.String anonID,
                      NetworkID netID,
                      boolean isAdditive,
                      PolicyProfile policy,
                      com.scms.common.QuotaOperation quotaOperation)

SubscriberData

public SubscriberData(com.scms.common.ExtendedAttributes esa,
                      java.lang.String subID,
                      java.lang.String anonID,
                      NetworkID netID,
                      boolean isAdditive,
                      PolicyProfile policy,
                      com.scms.common.QuotaOperation quotaOperation)
Constructor to support ExtendedAttributes for the subscriber in pull mode

Since:
SCE 3.6.5 Version

SubscriberData

public SubscriberData(com.scms.common.ExtendedAttributes esa,
                      java.lang.String subID,
                      NetworkID netID,
                      boolean isAdditive,
                      PolicyProfile policy,
                      com.scms.common.QuotaOperation quotaOperation)
Constructor to support ExtendedAttributes for the subscriber in push mode

Since:
SCE 3.6.5 Version

SubscriberData

public SubscriberData(com.scms.common.ExtendedAttributes esa,
                      java.lang.String subID,
                      java.lang.String anonID,
                      NetworkID netID,
                      boolean isAdditive,
                      PolicyProfile policy,
                      com.scms.common.QuotaOperation quotaOperation,
                      com.scms.common.Quota quota)
Constructor to support ExtendedAttributes for the subscriber

Since:
SCE 3.6.5 Version

SubscriberData

public SubscriberData(java.lang.String subID,
                      java.lang.String anonID,
                      NetworkID netID,
                      boolean isAdditive,
                      PolicyProfile policy,
                      com.scms.common.QuotaOperation quotaOperation,
                      com.scms.common.Quota quota)
Method Detail

addNetworkID

public void addNetworkID(java.lang.String mapping,
                         short type)

readObject

public static com.scms.common.BufferUtils.GetResult readObject(byte[] buf,
                                                               int pos)
                                                        throws java.lang.IllegalArgumentException
Throws:
java.lang.IllegalArgumentException

writeObject

public int writeObject(byte[] buf,
                       int pos)
                throws java.lang.IllegalArgumentException
Specified by:
writeObject in interface com.pcube.management.framework.rpc.GenericSerializable
Throws:
java.lang.IllegalArgumentException

getSubscriberID

public java.lang.String getSubscriberID()
the subscriber's ID (name)

Returns:
subscriber ID

getAnonymousID

public java.lang.String getAnonymousID()
the ID of the temporay subscriber which was created in the SCE. relevant only for pull-requests and pull-responses.

Returns:
the ID of the temporay subscriber which was created in the SCE

getMappings

public java.lang.String[] getMappings()
network Ids in string format

Returns:
network Ids in string format

getTypes

public short[] getTypes()
network ID types

Returns:
network ID types

getAdditiveFlag

public boolean getAdditiveFlag()
whether the network IDs should be added to the existing ones. relevant only in login operations.

Returns:
whether the network IDs should be added to the existing ones.

getPolicyStrings

public java.lang.String[] getPolicyStrings()
policy profile in string format (as used in the PolicyProfule constructor)

Returns:
policy profile in string format

getQuotaStrings

public java.lang.String[] getQuotaStrings()
Quota represented as a string

Returns:
Quota represented as a string

getQuotaOperationStrings

public java.lang.String[] getQuotaOperationStrings()
Quota operation represented as strings

Returns:
Quota operation represented as strings

getExtendedAttributes

public com.scms.common.ExtendedAttributes getExtendedAttributes()
ExtendedAttributes of the subscriber

Returns:
ExtendedAttributes of the subscriber

checkSubscriberId

public static void checkSubscriberId(java.lang.String subscriberId,
                                     boolean allowNull)
                              throws java.lang.IllegalArgumentException
verifies the subscriber ID is legal

Parameters:
subscriberId -
allowNull -
Throws:
java.lang.IllegalArgumentException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Cisco Systems Inc. Confidential