Package onep :: Package aaa :: Module Attribute :: Class Attribute
[frames] | no frames]

Class Attribute



The Attribute class stores the AAA attributes defined for a user.
An attributes list can consist of the following attributes:
- Any Standard IETF attribute
- Any Vendor Specific Attribute defined by Vendors such as Cisco, Microsoft, etc. and Standards Bodies such as 3GPP2, WiMAX Forum, etc.
- allowed-action - Cisco's custom attribute (specifically defined for ConnectedApps) for action- based authorization
- app-attr - Cisco's custom attribute (specifically defined for ConnectedApps) for any application- defined attribute name value pair

The two new attributes allowed-action and app-attr will be
stored in the AAA User's Authorization Profile on the AAA Server.
- Attribute allowed-action - use this attribute to specify
        names of Application-specific actions that a user is
        authorized to perform.

        Format - The format for this attribute setting on AAA server is
            cisco-avpair = "allowed-action=<appname>:<action-name>"

        Examples
            cisco-avpair = "allowed-action=appname:action-name1"
            cisco-avpair = "allowed-action=appname:action-name2"

        The {@link aaa.User#authenticate(java.util.List)} method can be used
        to check if the action a user is attempting to perform matches
        the action-name listed in the user's profile on the AAA server.

- Attribute app-attr - use this attribute
        for any application-specific parameter.
        One possible use is to leverage AAA for Application-specific
        configuration parameters or properties.

        Format - The format for this attribute setting on AAA server is
             cisco avpair = "app-attr=<avpair-name>:<avpair-format>:<avpair-value>"

        Examples
            cisco-avpair = "app-attr=attrname1:type:attrvalue1"
            cisco-avpair = "app-attr=attrname2:type:attrvalue2"

       Currently String and Integer are supported for the type.

Instance Methods
 
__init__(self, type_, name)
Create a AAA Attribute that has the specified type.
 
toIDL(self, network_element)
For internal use only

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

Class Methods
 
toIDLList(cls, attrList, network_element)
For internal use only
 
fromIDL(cls, attrIDL, network_element)
For internal use only
 
fromIDLList(cls, attrIdlList, network_element)
For internal use only
Class Variables
  log = None
Instance Variables
  type_
The AAA Attribute type
  name
The attribute name.
Properties

Inherited from object: __class__

Method Details

__init__(self, type_, name)
(Constructor)

 

Create a AAA Attribute that has the specified type. This constructor creates an Attribute with the given Attribute type and name. The Application-specific attributes are keyed on attribute names, hence the name parameters are required parameters for application-specific attributes.

Raises:
Overrides: object.__init__

Instance Variable Details

name

The attribute name. The attribute name can be a standard IETF AAA attribute or a custom application-specific attribute. Custom attributes of only the following form will be available via this API: cisco avpair = "app-attr=user-shell:string:bash" For the above attribute, the given method will return the name user-shell.