org.ocap.hn.security

Interface NetAuthorizationHandler

public interface NetAuthorizationHandler

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	notifyAction(String actionName, InetAddress inetAddress, String macAddress, int activityId) Notifies the authorization handler application that an action it registered interest in has been received.
void	notifyActivityEnd(int activityId) Notifies the registered authorization handler application that an activity has ended.
boolean	notifyActivityStart(InetAddress inetAddress, String macAddress, URL url, int activityId) Notifies the registered authorization handler application that an activity to access cable services has been started.

Method Detail

notifyActivityStart

boolean notifyActivityStart(InetAddress inetAddress,
                          String macAddress,
                          URL url,
                          int activityId)

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

Parameters:

inetAddress - IP address the transaction was sent from.

macAddress - MAC address the transaction was sent from if present at any layer of the received communications protocol. Can be empty String if not present. The format is EUI-48 with 6 colon separated 2 digit bytes in hexadecimal notation with no leading "0x", e.g. "00:11:22:AA:BB:CC".

url - The URL requested by the transaction.

activityId - The unique identifier of the activity, e.g. recorded content playback.

Returns:

True if the activity is accepted, otherwise returns false.

notifyActivityEnd

void notifyActivityEnd(int activityId)

Notifies the registered authorization handler application that an activity has ended.

Parameters:

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

notifyAction

boolean notifyAction(String actionName,
                   InetAddress inetAddress,
                   String macAddress,
                   int activityId)

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

Parameters:

actionName - Name of the action received. Will match the name passed to the NetSecurityManager.setAuthorizationApplication method.

inetAddress - IP address the transaction was sent from.

macAddress - MAC address the transaction was sent from if present at any layer of the received communications protocol. Can be empty String if not present. The format is EUI-48 with 6 colon separated 2 digit bytes in hexadecimal notation with no leading "0x", e.g. "00:11:22:AA:BB:CC".

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

Returns:

True if the activity is accepted, otherwise returns false.