org.tinyradius.attribute

类 VendorSpecificAttribute

java.lang.Object

org.tinyradius.attribute.RadiusAttribute

org.tinyradius.attribute.VendorSpecificAttribute

public class VendorSpecificAttribute
extends RadiusAttribute

This class represents a "Vendor-Specific" attribute.

字段概要

字段

限定符和类型	字段和说明
static int	VENDOR_SPECIFIC Radius attribute type code for Vendor-Specific

构造器概要

构造器

构造器和说明
VendorSpecificAttribute() Constructs an empty Vendor-Specific attribute that can be read from a Radius packet.
VendorSpecificAttribute(int vendorId) Constructs a new Vendor-Specific attribute to be sent.

方法概要

方法

限定符和类型	方法和说明
void	addSubAttribute(RadiusAttribute attribute) Adds a sub-attribute to this attribute.
void	addSubAttribute(String name, String value) Adds a sub-attribute with the specified name to this attribute.
int	getChildVendorId() Returns the vendor ID of the sub-attributes.
RadiusAttribute	getSubAttribute(int type) Returns a sub-attribute of the given type which may only occur once in this attribute.
RadiusAttribute	getSubAttribute(String type) Returns a single sub-attribute of the given type name.
List	getSubAttributes() Returns the list of sub-attributes.
List	getSubAttributes(int attributeType) Returns all sub-attributes of this attribut which have the given type.
String	getSubAttributeValue(String type) Returns the value of the Radius attribute of the given type or null if there is no such attribute.
void	readAttribute(byte[] data, int offset, int length) Reads a Vendor-Specific attribute and decodes the internal sub-attribute structure.
void	removeSubAttribute(RadiusAttribute attribute) Removes the specified sub-attribute from this attribute.
void	setChildVendorId(int childVendorId) Sets the vendor ID of the child attributes.
void	setDictionary(Dictionary dictionary) Also copies the new dictionary to sub-attributes.
String	toString() Returns a string representation for debugging.
byte[]	writeAttribute() Renders this attribute as a byte array.

从类继承的方法 org.tinyradius.attribute.RadiusAttribute

createRadiusAttribute, createRadiusAttribute, createRadiusAttribute, getAttributeData, getAttributeType, getAttributeTypeObject, getAttributeValue, getDictionary, getVendorId, setAttributeData, setAttributeType, setAttributeValue, setVendorId

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

VENDOR_SPECIFIC

public static final int VENDOR_SPECIFIC

Radius attribute type code for Vendor-Specific

另请参阅:

常量字段值

构造器详细资料

VendorSpecificAttribute

public VendorSpecificAttribute()

Constructs an empty Vendor-Specific attribute that can be read from a Radius packet.

VendorSpecificAttribute

public VendorSpecificAttribute(int vendorId)

Constructs a new Vendor-Specific attribute to be sent.

参数:

vendorId - vendor ID of the sub-attributes

方法详细资料

setChildVendorId

public void setChildVendorId(int childVendorId)

Sets the vendor ID of the child attributes.

参数:

childVendorId -

getChildVendorId

public int getChildVendorId()

Returns the vendor ID of the sub-attributes.

返回:

vendor ID of sub attributes

setDictionary

public void setDictionary(Dictionary dictionary)

Also copies the new dictionary to sub-attributes.

覆盖:

setDictionary 在类中 RadiusAttribute

参数:

dictionary - dictionary to set

另请参阅:

RadiusAttribute.setDictionary(org.tinyradius.dictionary.Dictionary)

addSubAttribute

public void addSubAttribute(RadiusAttribute attribute)

Adds a sub-attribute to this attribute.

参数:

attribute - sub-attribute to add

addSubAttribute

public void addSubAttribute(String name,
                   String value)

Adds a sub-attribute with the specified name to this attribute.

参数:

name - name of the sub-attribute

value - value of the sub-attribute

抛出:

IllegalArgumentException - invalid sub-attribute name or value

removeSubAttribute

public void removeSubAttribute(RadiusAttribute attribute)

Removes the specified sub-attribute from this attribute.

参数:

attribute - RadiusAttribute to remove

getSubAttributes

public List getSubAttributes()

Returns the list of sub-attributes.

返回:

List of RadiusAttribute objects

getSubAttributes

public List getSubAttributes(int attributeType)

Returns all sub-attributes of this attribut which have the given type.

参数:

attributeType - type of sub-attributes to get

返回:

list of RadiusAttribute objects, does not return null

getSubAttribute

public RadiusAttribute getSubAttribute(int type)

Returns a sub-attribute of the given type which may only occur once in this attribute.

参数:

type - sub-attribute type

返回:

RadiusAttribute object or null if there is no such sub-attribute

抛出:

RuntimeException - if there are multiple occurences of the requested sub-attribute type

getSubAttribute

public RadiusAttribute getSubAttribute(String type)
                                throws RadiusException

Returns a single sub-attribute of the given type name.

参数:

type - attribute type name

返回:

RadiusAttribute object or null if there is no such attribute

抛出:

RuntimeException - if the attribute occurs multiple times

RadiusException

getSubAttributeValue

public String getSubAttributeValue(String type)
                            throws RadiusException

Returns the value of the Radius attribute of the given type or null if there is no such attribute.

参数:

type - attribute type name

返回:

value of the attribute as a string or null if there is no such attribute

抛出:

IllegalArgumentException - if the type name is unknown

RuntimeException - attribute occurs multiple times

RadiusException

writeAttribute

public byte[] writeAttribute()

Renders this attribute as a byte array.

覆盖:

writeAttribute 在类中 RadiusAttribute

返回:

attribute

另请参阅:

RadiusAttribute.writeAttribute()

readAttribute

public void readAttribute(byte[] data,
                 int offset,
                 int length)
                   throws RadiusException

Reads a Vendor-Specific attribute and decodes the internal sub-attribute structure.

覆盖:

readAttribute 在类中 RadiusAttribute

抛出:

RadiusException

另请参阅:

RadiusAttribute.readAttribute(byte[], int, int)

toString

public String toString()

Returns a string representation for debugging.

覆盖:

toString 在类中 RadiusAttribute

另请参阅:

RadiusAttribute.toString()