org.ocap.hn.security

Interface NetAuthorizationHandler2

public interface NetAuthorizationHandler2

This interface represents a callback mechanism to a registered network authorization handler.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	notifyAction(String actionName, InetAddress inetAddress, int activityID, String[] request, NetworkInterface networkInterface) Notifies the authorization handler that an action it registered interest in has been received.
void	notifyActivityEnd(int activityID, int resultCode) Notifies the registered authorization handler that an activity has ended.
boolean	notifyActivityStart(InetAddress inetAddress, URL url, int activityID, ContentEntry entry, String[] request, NetworkInterface networkInterface) Notifies the registered authorization handler that an activity to access cable services has been started.

Method Detail

notifyActivityStart

boolean notifyActivityStart(InetAddress inetAddress,
                          URL url,
                          int activityID,
                          ContentEntry entry,
                          String[] request,
                          NetworkInterface networkInterface)

Notifies the registered authorization handler that an activity to access cable services has been started. The handler will permit or deny the ability for the activity to continue.

Parameters:

inetAddress - IP address the transaction was sent from.

url - The URL requested by the transaction.

activityID - The unique identifier of the activity.

entry - The ContentEntry corresponding to the url parameter. If no entry can be uniquely matched then null is passed in.

request - The HTTP message request; i.e., the request line and subsequent message headers.

networkInterface - The NetworkInterface the session identified by activityID took place on. The getInetAddress method of this parameter SHALL return the InetAddress on which the request was received.

Returns:

true if the activity is accepted; false otherwise.

notifyActivityEnd

void notifyActivityEnd(int activityID,
                     int resultCode)

Notifies the registered authorization handler that an activity has ended.

Parameters:

activityID - Unique identifier assigned to the activity and passed to the notifyActivityStart method.

resultCode - Value indicating success or failure.

notifyAction

boolean notifyAction(String actionName,
                   InetAddress inetAddress,
                   int activityID,
                   String[] request,
                   NetworkInterface networkInterface)

Notifies the authorization handler that an action it registered interest in has been received.

Parameters:

actionName - Name of the action received. Will match a name in the actionNames parameter previously passed to NetSecurityManager.setAuthorizationHandler(NetAuthorizationHandler2, String[], boolean).

inetAddress - IP address the transaction was sent from.

activityID - The unique identifier of the activity if known. If no activityID is associated with the transaction the implementation SHALL pass a value of -1;

request - The HTTP message request; i.e., the request line and subsequent message headers.

networkInterface - The NetworkInterface the session identified by activityID took place on. The getInetAddress method of this parameter SHALL return the InetAddress on which the request was received.

Returns:

true if the activity is accepted; false otherwise.