sspPlugin.PluginInterface Interface Reference

Basic plug-in interface. More...

import "sspPlugin.idl";

Inheritance diagram for sspPlugin.PluginInterface:

List of all members.

Classes
exception	AuthorizationDenied
	Sent if authorization is denied. More...
exception	AuthorizationDeniedW
	If the ORB supports wstring (unicode characters), this exception can be raised instead of AuthorizationDenied. More...
exception	MethodNotImplemented
	A plug-in can throw MethodNotImplemented if the plug-in does not implement a method. More...
exception	OutOfSync
	This exception is raised when a state synchronization plug-in receives a plug-in event while the state of the plug-in is not synchronized. More...
Public Member Functions
NameValueList	authorize (in PluginEventType pet, in PluginContext ctx, in NameValueList attr) raises (MethodNotImplemented, AuthorizationDeniedW, AuthorizationDenied, OutOfSync )
	The authorize() method is called when an authorization event is passed to the plug-in.
void	track (in PluginEventType pet, in PluginContext ctx, in NameValueList nvl, inout SubscriptionInfo subscription) raises (MethodNotImplemented, OutOfSync)
	The track() method is called when a tracking event is passed to the plug-in.

---

Detailed Description

Basic plug-in interface.

A plug-in context object is provided to allow plug-ins to interact with the core SAE. The plug-in context object is valid only during the call. After failover a new context object is created.

Defines the basic interface that each plug-in must implement.

• Authorization plug-ins are called before a subscriber or service session starts. The plug-ins can deny access or modify the requested session parameters.
• Tracking plug-ins are called after a subscriber or service session is started or stopped. Plug-ins can use information passed to keep the state of currently active subscriber and service sessions, as well as generate customized accounting records.

---

Member Function Documentation

NameValueList sspPlugin.PluginInterface.authorize	(	in PluginEventType	pet,
		in PluginContext	ctx,
		in NameValueList	attr
	)			raises (MethodNotImplemented, AuthorizationDeniedW, AuthorizationDenied, OutOfSync )

The authorize() method is called when an authorization event is passed to the plug-in.

The plug-in can return a list of attributes to the SAE. Only the attributes PA_RADIUS_CLASS, PA_REPLY_MESSAGE, PA_SESSION_TIMEOUT, PA_SERVICE_BUNDLE, PA_SESSION_VOLUME_QUOTA, PA_LOAD_SERVICES, PA_IDLE_TIMEOUT, PA_IDLE_TIMEOUT_INPUT, PA_IDLE_TIMEOUT_OUTPUT, PA_POOL_NAME, and PA_SESSION_VOLUME_QUOTA are recognized. All other returned attributes are ignored.

Parameters:

[in]	pet	Plug-in event type; for example, user, service, or subscription
[in]	ctx	Context callback; allows the plug-in to retrieve LDAP context information
[in]	attr	Plug-in attributes; list of attributes that are sent to the plug-in

Exceptions:

	MethodNotImplemented	Raised if the plug-in does not implement authorization
	AuthorizationDenied	Raised if authorization is denied
	AuthorizationDeniedW	If the ORB supports wstring (unicode characters); can be raised instead of AuthorizationDenied
	OutOfSync	Raised if the plug-in is out of sync

Returns:

A list of attributes that contain authorization parameters.

void sspPlugin.PluginInterface.track	(	in PluginEventType	pet,
		in PluginContext	ctx,
		in NameValueList	nvl,
		inout SubscriptionInfo	subscription
	)			raises (MethodNotImplemented, OutOfSync)

The track() method is called when a tracking event is passed to the plug-in.

Plug-ins can use information passed to keep state of active subscriber and service sessions, as well as to generate customized accounting records.

Parameters:

[in]	pet	Plug-in event type; that is, start, stop, user, or interim update service
[in]	ctx	Context callback; allows the plug-in to retrieve LDAP context information
[in]	nvl	Name value list; list of attributes that are sent to the plug-in
[in,out]	subscription	Subscription information; modifiable timeout parameters for service sessions

Exceptions:

	MethodNotImplemented	Raised if the plug-in is not a tracking plug-in
	OutOfSync	Raised if the plug-in is out of sync

---

The documentation for this interface was generated from the following file:

• sspPlugin.idl