net.jradius.packet.attribute

Class AttributeFactory

java.lang.Object

net.jradius.packet.attribute.AttributeFactory

public final class AttributeFactory
extends Object

The Attribute Factor. This factor builds the RADIUS attributes based on configured dictionaries.

Author:

David Bird

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttributeFactory.AttributeFactoryPool
static class	AttributeFactory.VendorValue

Constructor Summary

Constructors

Constructor and Description
AttributeFactory()

Method Summary

Modifier and Type	Method and Description
static int	addToAttributeList(AttributeList list, long type, byte[] value, boolean pool)
static byte[]	assembleAttributeList(AttributeList list, long type)
static RadiusAttribute	attributeFromString(String src) Parses a string to create a RadiusAttribute.
static RadiusAttribute	borrow(Long key)
static RadiusAttribute	copyAttribute(RadiusAttribute a)
static RadiusAttribute	copyAttribute(RadiusAttribute a, boolean pool)
static LinkedHashMap<Long,Class<?>>	getAttributeMap()
static LinkedHashMap<String,Class<?>>	getAttributeNameMap()
static String	getPoolStatus()
static long	getTypeByName(String aName) The the integer type of a RadiusAttribute by name
static LinkedHashMap<Long,Class<?>>	getVendorMap()
static LinkedHashMap<Long,AttributeFactory.VendorValue>	getVendorValueMap()
static boolean	loadAttributeDictionary(AttributeDictionary dict)
static boolean	loadAttributeDictionary(String className) Load an attribute dictionary
static void	loadAttributesFromString(AttributeList list, String src, String delim, boolean beStrinct)
static RadiusAttribute	newAttribute(AttributeDescription desc) Create a new RadiusAttribute based on a AttributeDescription
static RadiusAttribute	newAttribute(Long key)
static RadiusAttribute	newAttribute(long type, byte[] value, boolean pool) Creates a new RadiusAttribute
static RadiusAttribute	newAttribute(long vendor, long type, byte[] value, int op, boolean pool) Creates a new RadiusAttribute
static RadiusAttribute	newAttribute(long vendor, long type, long len, int op, ByteBuffer buffer, boolean pool)
static RadiusAttribute	newAttribute(Long key, Serializable value, boolean pool)
static RadiusAttribute	newAttribute(String aName) Create a RadiusAttribute by name
static RadiusAttribute	newAttribute(String aName, String aValue, String aOp) Creates a new RadiusAttribute
static AttributeList	newAttributeList(long type, byte[] value, boolean pool)
static void	poolStatus()
static void	recycle(AttributeList list)
static void	recycle(RadiusAttribute a)

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeFactory

public AttributeFactory()

Method Detail

newAttribute

public static RadiusAttribute newAttribute(Long key)
                                    throws Exception

Throws:

Exception

newAttribute

public static RadiusAttribute newAttribute(Long key,
                                           Serializable value,
                                           boolean pool)

copyAttribute

public static RadiusAttribute copyAttribute(RadiusAttribute a)

copyAttribute

public static RadiusAttribute copyAttribute(RadiusAttribute a,
                                            boolean pool)

borrow

public static RadiusAttribute borrow(Long key)
                              throws NoSuchElementException,
                                     IllegalStateException,
                                     Exception

Throws:

NoSuchElementException

IllegalStateException

Exception

loadAttributeDictionary

public static boolean loadAttributeDictionary(String className)

Load an attribute dictionary

Parameters:

className - Name of the Java Class derived from AttributeDictionary

Returns:

Returns true if loading of dictionary was successful

loadAttributeDictionary

public static boolean loadAttributeDictionary(AttributeDictionary dict)

attributeFromString

public static RadiusAttribute attributeFromString(String src)
                                           throws RadiusException,
                                                  UnknownAttributeException

Parses a string to create a RadiusAttribute. Will either return the attribute, or throw an Exception.

Parameters:

src - The source String

Returns:

Returns the RadiusAttribute parsed from String

Throws:

RadiusException

UnknownAttributeException

loadAttributesFromString

public static void loadAttributesFromString(AttributeList list,
                                            String src,
                                            String delim,
                                            boolean beStrinct)
                                     throws RadiusException

Throws:

RadiusException

newAttribute

public static RadiusAttribute newAttribute(long vendor,
                                           long type,
                                           byte[] value,
                                           int op,
                                           boolean pool)

Creates a new RadiusAttribute

Parameters:

vendor - The VendorID of the attribute (if one)

type - The Attribute Type

value - The Attribute Value

op - The Attribute Operator

Returns:

Returns the newly created RadiusAttribute

newAttribute

public static RadiusAttribute newAttribute(long vendor,
                                           long type,
                                           long len,
                                           int op,
                                           ByteBuffer buffer,
                                           boolean pool)

newAttribute

public static RadiusAttribute newAttribute(long type,
                                           byte[] value,
                                           boolean pool)

Creates a new RadiusAttribute

Parameters:

type - The type of the attribute

value - The value of the attribute

Returns:

Returns the newly created RadiusAttribute

newAttributeList

public static AttributeList newAttributeList(long type,
                                             byte[] value,
                                             boolean pool)

Parameters:

type - The type of the attribute

value - The value of the attribute

Returns:

Returns the newly created AttributeList

addToAttributeList

public static int addToAttributeList(AttributeList list,
                                     long type,
                                     byte[] value,
                                     boolean pool)

Parameters:

list - The AttributeList to add to

type - The type of the attribute

value - The value of the attribute

Returns:

Returns how many attributes created

assembleAttributeList

public static byte[] assembleAttributeList(AttributeList list,
                                           long type)

newAttribute

public static RadiusAttribute newAttribute(String aName)
                                    throws UnknownAttributeException

Create a RadiusAttribute by name

Parameters:

aName - The name of the attribute to create

Returns:

Returns the newly created RadiusAttribute

Throws:

UnknownAttributeException

newAttribute

public static RadiusAttribute newAttribute(AttributeDescription desc)
                                    throws UnknownAttributeException

Create a new RadiusAttribute based on a AttributeDescription

Parameters:

desc - The RadiusDescription

Returns:

Returns the newly created RadiusAttribute

Throws:

UnknownAttributeException

newAttribute

public static RadiusAttribute newAttribute(String aName,
                                           String aValue,
                                           String aOp)
                                    throws UnknownAttributeException

Creates a new RadiusAttribute

Parameters:

aName - The name of the attribute to create

aValue - The value of the attribute

aOp - The "operator" of the attribute

Returns:

Returns the newly created RadiusAttribute

Throws:

UnknownAttributeException

getTypeByName

public static long getTypeByName(String aName)
                          throws UnknownAttributeException

The the integer type of a RadiusAttribute by name

Parameters:

aName - The name of the attribute

Returns:

Returns the integer type of the attribute

Throws:

UnknownAttributeException

getAttributeMap

public static LinkedHashMap<Long,Class<?>> getAttributeMap()

Returns:

Returns the attributeMap.

getAttributeNameMap

public static LinkedHashMap<String,Class<?>> getAttributeNameMap()

Returns:

Returns the attributeNameMap.

getVendorMap

public static LinkedHashMap<Long,Class<?>> getVendorMap()

Returns:

Returns the vendorMap.

getVendorValueMap

public static LinkedHashMap<Long,AttributeFactory.VendorValue> getVendorValueMap()

Returns:

Returns the vendorValueMap.

poolStatus

public static void poolStatus()

getPoolStatus

public static String getPoolStatus()

recycle

public static void recycle(RadiusAttribute a)

recycle

public static void recycle(AttributeList list)