com.ibm.diameter.sh.util
Class IMSUserState

java.lang.Object
  extended by com.ibm.diameter.sh.util.UserState
      extended by com.ibm.diameter.sh.util.IMSUserState

public class IMSUserState
extends UserState

The IMSUserState object correlates to the IMSUserState element defined in ShDataType.xsd. IMSUserState extends the UserState object. The ShDataType.xsd schema defines the follwing states for IMSUserState:

See Also:
UserState, com.ibm.diameter.sh.DiameterShService#getIMSUserState, com.ibm.diameter.sh.DiameterShService#getUserData

Field Summary
static int AUTHENTICATION_PENDING
           
static int NOT_REGISTERED
           
static int REGISTERED
           
static int REGISTERED_UNREG_SERVICES
           
 
Constructor Summary
IMSUserState()
           
 
Method Summary
 int getUserState()
          Used by an IMS Application Server application to retrieve the IMSUserState value.
static boolean isIMSUserStateDefined(int state)
          Used by the Sh subscriber profile Web service to determine if the IMSUserState value received from the HSS is recognized as a valid state value.
 void setUserState(int state)
          Used by the Sh subscriber profile Web service to set IMSUserState after parsing the XML file received from the HSS.
 java.lang.String toString()
          Debug method that returns the IMSUserState as a String for inclusion in (English only) trace logs.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NOT_REGISTERED

public static final int NOT_REGISTERED
See Also:
Constant Field Values

REGISTERED

public static final int REGISTERED
See Also:
Constant Field Values

REGISTERED_UNREG_SERVICES

public static final int REGISTERED_UNREG_SERVICES
See Also:
Constant Field Values

AUTHENTICATION_PENDING

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

IMSUserState

public IMSUserState()
Method Detail

getUserState

public int getUserState()
Used by an IMS Application Server application to retrieve the IMSUserState value.

Specified by:
getUserState in class UserState
Returns:
IMSUserState

setUserState

public void setUserState(int state)
Used by the Sh subscriber profile Web service to set IMSUserState after parsing the XML file received from the HSS.

Specified by:
setUserState in class UserState
Parameters:
Sets - the IMSUserState.

isIMSUserStateDefined

public static boolean isIMSUserStateDefined(int state)
Used by the Sh subscriber profile Web service to determine if the IMSUserState value received from the HSS is recognized as a valid state value.

Parameters:
state - value to be tested
Returns:
boolean indicating whether the specified state value is valid

toString

public java.lang.String toString()
Debug method that returns the IMSUserState as a String for inclusion in (English only) trace logs.

Overrides:
toString in class java.lang.Object
Returns:
The String representation of this object for debug purposes only.


Copyright © 2006 IBM Corp. All Rights Reserved.