org.ocap.application.AppPattern.html Maven / Gradle / Ivy

AppPattern is an element that constitutes an AppFilter. An AppPattern has the following attributes:

• idPattern - a group of AppIDs.
• action - an action (ALLOW, DENY, or ASK) for matching applications.
• priority - a priority that determines the search order position in an AppFilter. The highest priority is 255, the lowest is 0.
• expirationTime - An expiration time. Optional.
• info - an MSO-private data. Optional. Could be a String. AppFilterHandler may use it for making a decision.

idPattern specifies an AppID group with a String: a pair of ranges for Organization IDs and Application IDs. The syntax is:

"oid1[-oid2][:aid1[-aid2]]"

• oid1 and oid2 specify a range of Organization IDs inclusive. Each of them must be a 32-bit value.
• aid1 and aid2 specify a range of Application IDs inclusive. Each of them must be a 16-bit value.
• oid2 and aid2 must be greater than oid1 and aid1, respectively.
• The encoding of these IDs follows 14.5 Text encoding of application identifiers of DVB-MHP 1.0.2 [11]; hexadecimal, lower case, no leading zeros.
• Symbols in brackets are optional.
• When oid2 is omitted, only oid1 is in the range.
• When aid2 is omitted, only aid1 is in the range.
• When both aid1 and aid2 are omitted, all Application IDs are in the range.

See AppFilter for the examples.

See Also:

AppFilter, AppFilterHandler

ALLOW

public static final int ALLOW

When AppFilter.accept finds a matching AppPattern with this action, it returns true.

See Also:

AppFilter.accept(org.dvb.application.AppID), Constant Field Values

DENY

public static final int DENY

When AppFilter.accept finds a matching AppPattern with this action, it returns false.

See Also:

AppFilter.accept(org.dvb.application.AppID), Constant Field Values

ASK

public static final int ASK

When AppFilter.accept finds a matching AppPattern with this action, it asks AppFilterHandler.accept for the decision.

See Also:

AppFilter.accept(org.dvb.application.AppID), AppFilterHandler.accept(org.dvb.application.AppID, org.ocap.application.AppPattern), Constant Field Values

AppPattern

public AppPattern(java.lang.String idPattern,
                  int action,
                  int priority)

Constructs a new AppPattern with no expiration.

Parameters:

idPattern - a String to specify an AppID group.

action - an action.

priority - a search order priority.

Throws:

java.lang.IllegalArgumentException - idPattern has a bad format, action or priority is out of range.

AppPattern

public AppPattern(java.lang.String idPattern,
                  int action,
                  int priority,
                  java.util.Date expirationTime,
                  java.lang.Object info)

Constructs a new AppPattern with an expiration time and MSO private information.

Parameters:

idPattern - a String to specify an AppID group.

action - an action.

priority - a search order priority.

expirationTime - time for this AppPattern to expire. null it never expires.

info - MSO specific information. Can be null.

Throws:

java.lang.IllegalArgumentException - idPattern has a bad format, action or priority is out of range.

getAppIDPattern

public java.lang.String getAppIDPattern()

Returns the pattern string that specifies a group of AppIDs.

Returns:

the pattern string.

getAction

public int getAction()

Returns the action associated with this AppPattern.

Returns:

the action.

getPriority

public int getPriority()

Returns the search order priority of this AppPattern.

Returns:

the search order priority.

getExpirationTime

public java.util.Date getExpirationTime()

Returns the time for this AppPattern to expire or null if it never expires.

Returns:

the expiration time or null.

getPrivateInfo

public java.lang.Object getPrivateInfo()

Returns MSO-private information of this AppPattern.

Returns:

the MSO private information.

equals

public boolean equals(java.lang.Object that)

Indicates whether some other object is "equal to" this one.

This method does not factor in expirationTime or info attributes, but does compare idPattern, action, and priority attributes.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object