Merge "Remove "response" from yang."
[packetcable.git] / packetcable-driver / src / main / java / org / pcmm / gates / IAMID.java
1 /**
2  @header@
3  */
4
5
6 package org.pcmm.gates;
7
8 import org.pcmm.base.IPCMMBaseObject;
9
10 /**
11  * <p>
12  * The AMID consists of two fields: the Application Manager Tag and Application
13  * Type. Each Application Manager is pre-provisioned with an Application Manager
14  * Tag that is unique within the universe of a single service provider. The
15  * Application Manager may also be pre-provisioned with a set of Application
16  * Type values that can be used to identify the particular application that a
17  * gate is associated with. The Application Manager includes the AMID in all
18  * messages that it issues to the Policy Server. The Policy Server transparently
19  * passes this information to the CMTS via Gate Control messages. The CMTS MUST
20  * return the AMID associated with the Gate to the Policy Server. The Policy
21  * Server uses this information to associate Gate messages with a particular
22  * Application Manager and Application Type.
23  * </p>
24  * <p>
25  * The Application Manager Tag MUST be a globally unique value assigned to the
26  * Application Manager by the service provider. The Application Manager MUST use
27  * the assigned Application Manager Tag in all its interactions with Policy
28  * Servers. Note that since the Application Manager may be operated by a third
29  * party, and a single Application Manager could interact with multiple service
30  * provider operators, a single physical Application Manager may be provisioned
31  * with multiple Application Manager Tags, and multiple Application Type sets
32  * (one for each configured Application Manager Tag).
33  * </p>
34  *
35  *
36  */
37 public interface IAMID extends IPCMMBaseObject {
38
39     static final short LENGTH = 8;
40     static final byte SNUM = 2;
41     static final byte STYPE = 1;
42
43     void setApplicationType(short type);
44
45     short getApplicationType();
46
47     void setApplicationMgrTag(short type);
48
49     short getApplicationMgrTag();
50
51 }