Package org.forgerock.openam.radius.common.packet

This package in large part contains the objects that model the RADIUS protocol specified in RFC 2865. The objects that implement the protocol include the four packet types, authenticators for request and response packet types, and all attribute fields. All attribute fields support two constructors. To be clear RFC 2865 refers to the on-the-wire bytes that represent a RADIUS object as the octets of that object where an octet is a single eight bit byte. One constructor for each attribute takes the octets and is responsible for extracting the model type represented by the value of that attribute. The other constructor takes the model object represented by the value of that attribute and generates the octets that can we sent on the wire for that attribute. When a RADIUS packet is received either in the RADIUS authentication module acting as a RADIUS client or in the RADIUS server, the on-the-wire octets are passed to the PacketFactory which splits instantiates the appropriate packet type with injected id, authenticator, and attributes found in the received octets. When preparing a packet from model objects in order to send it, the constructor on the packet type is used and then the attributes to be sent within the packet are then injected in. Once the packet is reacy its getOctets method will return the on-the-wire representation of the packet.

Class Summary

Class	Description
CallbackIdAttribute	Class representing the structure of the Callback-Id attribute as specified in section 5.20 of RFC 2865 and able to be instantiated from the on-the-wire bytes.
CallbackNumberAttribute	Class representing the structure of the Callback-Number attribute as specified in section 5.19 of RFC 2865 and able to be instantiated from the on-the-wire bytes.
CallerStationIdAttribute	Class representing the structure of the Called-Station-Id attribute as specified in section 5.30 of RFC 2865 and able to be instantiated from the on-the-wire bytes.
CallingStationIdAttribute	Class representing the structure of the Calling-Station-Id attribute as specified in section 5.31 of RFC 2865 and able to be instantiated from the on-the-wire bytes.
CHAPChallengeAttribute	Class representing the structure of the CHAP-Challenge attribute as specified in section 5.40 of RFC 2865 and able to be instantiated from the on-the-wire bytes.
CHAPPasswordAttribute	Class representing the structure of the CHAP-Password attribute as specified in section 5.3 of RFC 2865 and able to be instantiated from the on-the-wire bytes.
FilterIdAttribute	Class representing the structure of the Filter-Id attribute as specified in section 5.11 of RFC 2865 and able to be instantiated from the on-the-wire bytes or from its text value.
FramedAppleTalkLinkAttribute	Class representing the structure of the Framed-AppleTalk-Link attribute as specified in section 5.37 of RFC 2865.
FramedAppleTalkNetworkAttribute	Class representing the structure of the Framed-AppleTalk-Link attribute as specified in section 5.37 of RFC 2865.
FramedAppleTalkZoneAttribute	Class representing the structure of the Framed-AppleTalk-Zone attribute as specified in section 5.39 of RFC 2865 and able to be instantiated from the on-the-wire bytes or from its text value.
FramedCompressionAttribute	Class representing the structure of the Framed-Compression attribute as specified in section 5.13 of RFC 2865.
FramedIPAddressAttribute	Class representing the structure of the Framed-IP-Address attribute as specified in section 5.8 of RFC 2865.
FramedIPNetmaskAttribute	Class representing the structure of the Framed-IP-Netmask attribute as specified in section 5.9 of RFC 2865 and able to be instantiated from the on-the-wire bytes.
FramedIPXNetworkAttribute	Class representing the structure of the Framed-IPX Address attribute as specified in section 5.24 of RFC 2865.
FramedMTUAttribute	Class representing the structure of the Framed-MTU attribute as specified in section 5.12 of RFC 2865 and able to be instantiated from the on-the-wire bytes or from model objects.
FramedProtocolAttribute	Class representing the structure of the Framed-MTU attribute as specified in section 5.7 of RFC 2865 and able to be instantiated from the on-the-wire bytes or from model objects.
FramedRouteAttribute	Class representing the structure of the Framed-Route attribute as specified in section 5.22 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
FramedRoutingAttribute	Class representing the structure of the Framed-AppleTalk-Link attribute as specified in section 5.37 of RFC 2865.
IdleTimeoutAttribute	Class representing the structure of the Framed-AppleTalk-Link attribute as specified in section 5.28 of RFC 2865.
LoginIPHostAttribute	Class representing the structure of the Framed-AppleTalk-Link attribute as specified in section 5.14 of RFC 2865.
LoginLATGroupAttribute	Class representing the structure of the Framed-Route attribute as specified in section 5.36 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
LoginLATNodeAttribute	Class representing the structure of the Framed-Route attribute as specified in section 5.35 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
LoginLATPortAttribute	Class representing the structure of the Login-LAT-Port attribute as specified in section 5.43 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
LoginLATServiceAttribute	Class representing the structure of the Login-LAT-Service attribute as specified in section 5.34 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
LoginServiceAttribute	Class representing the structure of the Framed-Route attribute as specified in section 5.15 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
LoginTCPPortAttribute	Class representing the structure of the Login-TCP-Port attribute as specified in section 5.16 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
NASClassAttribute	Class representing the structure of the Class attribute as specified in section 5.25 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
NASIdentifierAttribute	Class representing the structure of the NAS-Identifier attribute as specified in section 5.32 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
NASIPAddressAttribute	Class representing the structure of the NAS-IP-Address attribute as specified in section 5.4 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
NASPortAttribute	Class representing the structure of the NAS-Port field as specified in section 5.5 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
NASPortTypeAttribute	Class representing the structure of the NAS-Port-Type field as specified in section 5.41 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
PortLimitAttribute	Class representing the structure of the Port-Limit field as specified in section 5.42 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
ProxyStateAttribute	Class representing the structure of the Proxy-State field as specified in section 5.33 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
ServiceTypeAttribute	Class representing the structure of the Service-Type field as specified in section 5.6 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
SessionTimeoutAttribute	Class representing the structure of the Session-Timeout field as specified in section 5.27 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
TerminationActionAttribute	Class representing the structure of the Termination-Action field as specified in section 5.29 of RFC 2865 and able to be instantiated from the on-the-wire bytes or model objects.
UnknownAttribute	Implements a special version of Attribute for handling attribute types received across the wire but not yet implemented but able to be received and logged.
VendorSpecificAttribute	Class representing the structure of the Vendor-Specific attribute as specified in section 5.26 of RFC 2865 and able to be instantiated from the on-the-wire bytes.

Enum Summary

Enum	Description
FramedIPAddressAttribute.Type	Indicator of types of FramedIPAddressAttribute to be instantiated.