Package onep :: Package identity :: Module identity :: Class IdentitySession
[frames] | no frames]

Class IdentitySession


IdentitySession represents a session record in the database in a network element.

Instance Methods
 
session_label(self)
 
__init__(self, parent, element, session_label)
x.__init__(...) initializes x; see help(type(x)) for signature
 
update_session_attributes(self, attr_list)
Updates the attributes of the session record in database.
 
fetch_session_attributes(self, retrieve_list=None)
Retrieves the attributes from a session record in database.
 
delete_session(self)
Deletes the session record from the database.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

Inherited from object: __class__

Method Details

session_label(self)

 
Decorators:
  • @property

__init__(self, parent, element, session_label)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

update_session_attributes(self, attr_list)

 

Updates the attributes of the session record in database. 

The method will fail if the session record hasn't been created previously using 
add_session(). Only the attributes passed in will be updated while retaining 
the older values for other attributes, if any. 

@param attr_list List of attributes that needed to be updated.

@throws OnepIllegalArgumentException
    The exception is thrown when any of input parameter is 
    invalid.
@throws OnepConnectionException
    The exception is thrown when the network element 
    is not connected.
@throws OnepRemoteProcedureException
    The exception is thrown when an error has 
    occurred in the remote procedure call made to the 
    network element.        

fetch_session_attributes(self, retrieve_list=None)

 

Retrieves the attributes from a session record in database. 

@param retrieve_list
    The retrieve_list specifies a list of Attribute to be retrieved. 
    If the optional retrieve_list is None or an empty list, 
    all attributes will be retrieved. 
    If the retrieve_list is not null, only a subset of 
    the attributes listed in the retrieveList will be retrieved.
        
@return the list of attributes retrieved.

@throws OnepIllegalArgumentException
    The exception is thrown when any of input parameter is 
    invalid.
@throws OnepConnectionException
    The exception is thrown when the network element 
    is not connected.
@throws OnepRemoteProcedureException
    The exception is thrown when an error has 
    occurred in the remote procedure call made to the 
    network element.

delete_session(self)

 

Deletes the session record from the database.

@throws OnepIllegalArgumentException
    The exception is thrown when any of input parameter is 
    invalid.
@throws OnepConnectionException
    The exception is thrown when the network element 
    is not connected.
@throws OnepRemoteProcedureException
    The exception is thrown when an error has 
    occurred in the remote procedure call made to the 
    network element.