org.llrp.ltk.generated.parameters
Class C1G2Lock

java.lang.Object
  org.llrp.ltk.types.LLRPParameter
      org.llrp.ltk.types.TLVParameter
          org.llrp.ltk.generated.parameters.C1G2Lock

All Implemented Interfaces:

AccessCommandOpSpec

public class C1G2Lock
extends TLVParameter
implements AccessCommandOpSpec

This parameter contains the definition of the access privilege updates (read/write/permalock) to be performed in various locations of the memory. The five data fields for which we can define access control using the lock command are: Kill Password, Access Password, EPC memory, TID memory and User memory. The access privilege updates are expressed as a list of C1G2LockPayload Parameters, one for each memory location.The Access Password provides the password to enter the secured state. A Reader can perform a lock operation on a tag only if the tag is in the secured state. The tag enters the secured state only using the Access Password (if a non-zero value). See also LLRP Specification Section 15.2.1.3.2.4 and LLRP Specification Section 16.3.1.3.2.4 .

Field Summary

protected UnsignedInteger	accessPassword
protected java.util.List<C1G2LockPayload>	c1G2LockPayloadList
protected UnsignedShort	opSpecID
static SignedShort	TYPENUM

Fields inherited from class org.llrp.ltk.types.TLVParameter

RESERVEDLENGTH, TYPENUMBERLENGTH

Fields inherited from class org.llrp.ltk.types.LLRPParameter

bitLength

Constructor Summary

C1G2Lock()
empty constructor to create new parameter.

C1G2Lock(org.jdom.Element element)
Constructor to create parameter from xml encoded parameter calls decodeXML to decode parameter.

C1G2Lock(LLRPBitList list)
Constructor to create parameter from binary encoded parameter calls decodeBinary to decode parameter.

Method Summary

void	addToC1G2LockPayloadList(C1G2LockPayload c1G2LockPayload) add element c1G2LockPayload of type C1G2LockPayload .
protected void	decodeBinarySpecific(LLRPBitList binary) decoding function to be implemented by each parameter
void	decodeXML(org.jdom.Element element) create objects from xml.
LLRPBitList	encodeBinarySpecific() protected method to force subclasses to implement their specific encoding
org.jdom.Content	encodeXML(java.lang.String name, org.jdom.Namespace ns) create xml representation of this parameter.
UnsignedInteger	getAccessPassword() get accessPassword of type UnsignedInteger.
java.util.List<C1G2LockPayload>	getC1G2LockPayloadList() get c1G2LockPayloadList of type List <C1G2LockPayload> .
java.lang.String	getName() name of parameter (same as class name)
UnsignedShort	getOpSpecID() get opSpecID of type UnsignedShort.
SignedShort	getTypeNum() type number uniquely identifies a parameter.
static java.lang.Integer	length() For TLV Parameter length can not be determined at compile time.
void	setAccessPassword(UnsignedInteger accessPassword) set accessPassword of type UnsignedInteger .
void	setC1G2LockPayloadList(java.util.List<C1G2LockPayload> c1G2LockPayloadList) set c1G2LockPayloadList of type List <C1G2LockPayload>.
void	setOpSpecID(UnsignedShort opSpecID) set opSpecID of type UnsignedShort .
java.lang.String	toString() return string representation.

Methods inherited from class org.llrp.ltk.types.TLVParameter

decodeBinary, encodeBinary

Methods inherited from class org.llrp.ltk.types.LLRPParameter

getByteLength

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.llrp.ltk.generated.interfaces.AccessCommandOpSpec

decodeBinary, encodeBinary

Field Detail

TYPENUM

public static final SignedShort TYPENUM

opSpecID

protected UnsignedShort opSpecID

accessPassword

protected UnsignedInteger accessPassword

c1G2LockPayloadList

protected java.util.List<C1G2LockPayload> c1G2LockPayloadList

Constructor Detail

C1G2Lock

public C1G2Lock()

empty constructor to create new parameter.

C1G2Lock

public C1G2Lock(LLRPBitList list)

Constructor to create parameter from binary encoded parameter calls decodeBinary to decode parameter.

Parameters:

list - to be decoded

C1G2Lock

public C1G2Lock(org.jdom.Element element)
         throws InvalidLLRPMessageException

Constructor to create parameter from xml encoded parameter calls decodeXML to decode parameter.

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

Method Detail

encodeBinarySpecific

public LLRPBitList encodeBinarySpecific()

protected method to force subclasses to implement their specific encoding

Specified by:

encodeBinarySpecific in class TLVParameter

Returns:

LLRPBitList

encodeXML

public org.jdom.Content encodeXML(java.lang.String name,
                                  org.jdom.Namespace ns)

create xml representation of this parameter.

Specified by:

encodeXML in interface AccessCommandOpSpec

Specified by:

encodeXML in class LLRPParameter

Parameters:

name - of element

ns - Namespace of elements

Returns:

JDom Content object

decodeBinarySpecific

protected void decodeBinarySpecific(LLRPBitList binary)

decoding function to be implemented by each parameter

Specified by:

decodeBinarySpecific in class TLVParameter

Parameters:

binary - binary representation of the parameter

decodeXML

public void decodeXML(org.jdom.Element element)
               throws InvalidLLRPMessageException

create objects from xml.

Specified by:

decodeXML in interface AccessCommandOpSpec

Specified by:

decodeXML in class LLRPParameter

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

setOpSpecID

public void setOpSpecID(UnsignedShort opSpecID)

set opSpecID of type UnsignedShort .

Parameters:

opSpecID - to be set

setAccessPassword

public void setAccessPassword(UnsignedInteger accessPassword)

set accessPassword of type UnsignedInteger .

Parameters:

accessPassword - to be set

setC1G2LockPayloadList

public void setC1G2LockPayloadList(java.util.List<C1G2LockPayload> c1G2LockPayloadList)

set c1G2LockPayloadList of type List <C1G2LockPayload>.

Parameters:

c1G2LockPayloadList - to be set

getOpSpecID

public UnsignedShort getOpSpecID()

get opSpecID of type UnsignedShort.

Returns:

type UnsignedShort to be set

getAccessPassword

public UnsignedInteger getAccessPassword()

get accessPassword of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getC1G2LockPayloadList

public java.util.List<C1G2LockPayload> getC1G2LockPayloadList()

get c1G2LockPayloadList of type List <C1G2LockPayload> .

Returns:

List <C1G2LockPayload>

addToC1G2LockPayloadList

public void addToC1G2LockPayloadList(C1G2LockPayload c1G2LockPayload)

add element c1G2LockPayload of type C1G2LockPayload .

Parameters:

c1G2LockPayload - of type C1G2LockPayload

length

public static java.lang.Integer length()

For TLV Parameter length can not be determined at compile time. This method therefore always returns 0.

Returns:

Integer always zero

getTypeNum

public SignedShort getTypeNum()

type number uniquely identifies a parameter.

Specified by:

getTypeNum in class LLRPParameter

Returns:

typeNum

getName

public java.lang.String getName()

name of parameter (same as class name)

Specified by:

getName in class LLRPParameter

Returns:

String

toString

public java.lang.String toString()

return string representation. All field values but no parameters are included

Overrides:

toString in class java.lang.Object

Returns:

String