|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.rfid.premises.app.access.SensorEventsAPIAccess
public abstract class SensorEventsAPIAccess
A SensorEventsAPIAccessAccess is an abstract class used to query for device information and send commands to devices.
Use the method SensorEventsAPIAccessContext#getPremisesAccess()
to
retrieve a SensorEventsAPIAccessAccess object.
SensorEventsAPIAccessRemote
,
SensorEventsAPIAccessLocal
,
SensorEventsAPIAccessContext
Constructor Summary | |
---|---|
SensorEventsAPIAccess()
|
Method Summary | |
---|---|
void |
clearALEData(java.lang.String location)
clears the ALE Data for a given location |
java.util.Map<java.lang.String,java.lang.String> |
decodeEPCValue(java.lang.String epcVal)
Decodes given EPC Hex value and retrun map for all the decoded values. |
void |
deleteControllerMetaData(java.lang.String controllerid,
java.lang.String keyname)
Deletes the metadata key and value for the given Controller object |
void |
deleteLocationMetaData(java.lang.String locationid,
java.lang.String keyname)
Deletes the metadata key and value for the given Location object |
ECReports[] |
getALEData(java.lang.String location)
gets the ECReports for a given location/reader |
java.lang.String[] |
getAllChildLocation(java.lang.String locationid)
Get all the child location id's for given location id Location id's will be in ascending order for example we have location topology - STORE 1 -> L99 -> L100 -> L101 -> L102 and get we try to child locations for L99 following will be array layout returned by API Array[0]L100 Array[1]L101 Array[2]L102 Array[3]L103 |
Controller[] |
getAllController()
Gets all Controller objects defined in the WebSphere Sensor Events |
Device[] |
getAllDevices()
Gets all Device objects defined in the WebSphere Sensor Events |
Device[] |
getAllDevicesByCategoryName(java.lang.String category)
Gets all Device objects defined in the WebSphere Sensor Events for given Device Category |
Location[] |
getAllLocation()
Gets all Location objects defined in the WebSphere Sensor Events |
java.lang.String[] |
getAllParentLocation(java.lang.String locationid)
Get all the parent location id's for given location id Location id's will be in descending order for example we have location topology - STORE 1 -> L99 -> L100 -> L101 -> L102 and get we try to parent locations for L102 following will be array layout returned by API Array[0]L101 Array[1]L100 Array[2]L99 Array[3]STORE 1 |
PassiveRFIDReader[] |
getAllPassiveRFIDReader()
Gets all PassiveRFIDReader objects defined in the WebSphere Sensor Events |
Printer[] |
getAllPrinters()
Gets all printers defined in the IBM WebSphere Sensor Events |
PrintTemplate[] |
getAllPrintTemplates()
Gets all of the print templates |
Controller |
getController(java.lang.String controllerid)
Gets the Controller object with the specified Controller ID |
java.util.HashMap<java.lang.String,java.lang.String> |
getControllerMetaData(java.lang.String controllerid)
Gets the metdadata values for given Controller |
Device |
getDevice(java.lang.String deviceid)
Gets the Device with the specified device ID |
protected abstract DeviceCommandsAdmin |
getDeviceCommandsAdmin()
Gets an object used to send device commands |
protected abstract DeviceConfigAdmin |
getDeviceConfigAdmin()
Gets an object used to get device configuration |
protected abstract DeviceDataAdmin |
getDeviceDataAdmin()
Gets an object used to get device data |
java.lang.String[] |
getDeviceIDByCategoryName(java.lang.String category)
Gets all Device objects defined in the WebSphere Sensor Events for given Device Category |
java.lang.String |
getDeviceStatus(java.lang.String locationId)
Gets the device status |
protected abstract EPCCommands |
getEPCCommand()
|
java.lang.String |
getEpcEncodingfromUrn(java.lang.String urn)
Parse an EPC tag URN of the form "urn:epc:tag:sgtin-64:0.1234567.200160.1" into its EPC encoding "sgtin-64" |
java.lang.String[] |
getEpcTagData(java.lang.String printJobId)
Gets the EPC Tag Data for a specific print job |
java.lang.String[] |
getEpcTagDataByBusinessRef(java.lang.String businessRef)
Gets the EPC Tag Data for a specific business reference |
HistoryForTagOutput[] |
getHistoryForTag(long startDateTime,
java.lang.String tag)
gets the TagHistories For given EPC Tag ID |
java.lang.String |
getItemReferenceIdByUrn(java.lang.String urn)
Gets an item reference from WebSphere Sensor Events based on human readable epc urn e.g., "sgtin-64:0.1234567.100110.1" note: urns stored in WebSphere Sensor Events are prepended with "urn:epc:tag:". |
Location |
getLocation(java.lang.String locationid)
Gets the Location object with the specified Location ID or Location Alias |
java.util.HashMap<java.lang.String,java.lang.String> |
getLocationMetaData(java.lang.String locationid)
Gets the metadata values for given Location |
PassiveRFIDReader |
getPassiveRFIDReader(java.lang.String id)
Gets all PassiveRFIDReader objects defined in the WebSphere Sensor Events |
java.lang.String |
getPremisesPropertiesKeyValue(java.lang.String key)
Gets the key value from System Agent |
PrintDetails |
getPrintDetails(java.lang.String printJobId)
Gets the PrintDetails for a specific print job |
PrintDetails[] |
getPrintDetailsByBusinessRef(java.lang.String businessRefId)
Gets the PrintDetails using a specified business reference ID |
Printer |
getPrinter(java.lang.String deviceid)
Gets the printer with the specified device ID |
PrinterType |
getPrinterType(java.lang.String printerTypeId)
Gets the PrinterType using the specified printer type ID |
PrintJob |
getPrintJob(java.lang.String printJobId)
Get registered print job |
java.lang.String |
getPrintJobIdByUrn(java.lang.String urn)
Gets a print job id from WebSphere Sensor Events based on human readable epc urn e.g., "sgtin-64:0.1234567.100110.1" note: urns stored in WebSphere Sensor Events are prepended with "urn:epc:tag:". |
PrintJob[] |
getPrintJobs()
Get all of the print jobs that have been registered. |
java.lang.String |
getPrintJobStatus(java.lang.String printJobId)
Get status for the given Print Job ID |
PrintTemplate[] |
getPrintTemplatesOfType(java.lang.String printerTypeId)
Gets the Print templates of the specified type |
protected abstract StatusAdmin |
getStatusAdmin()
Gets an object used to get device and job status |
SupplyChainProfile |
getSupplyChainProfile(java.lang.String id)
Gets the SupplyChainProfile with a specified ID |
SupplyChainProfile[] |
getSupplyChainProfiles()
Gets all of the SupplyChainProfiles that are currently defined |
protected abstract TagApiAdmin |
getTagApiAdmin()
Gets an object used to query the WebSphere Sensor Events tag history |
protected abstract TagCommissioningAdmin |
getTagCommissioningAdmin()
Gets an object used to interact with tag commissioning functions |
TagHistoriesForLocationOutput[] |
getTagHistoriesForLocation(long startDateTime,
java.lang.String locationId)
gets the TagHistories For given Location ID |
TagHistoriesForReaderOutput[] |
getTagHistoriesForReader(long startDateTime,
java.lang.String readerId)
gets the TagHistories For given Reader/Device ID |
java.lang.String |
printJob(java.lang.String locationid,
java.lang.String printerid,
PrintDetails pd)
Sends a print job command to the IBM WebSphere Sensor Events |
void |
publish(java.lang.String message)
Publishes message to IBM WebSphere Sensor Events messaging infrastructure. |
void |
publishOutBound(java.lang.String message)
Publishes message to IBM WebSphere Sensor Events output channel. |
void |
sendAcceptToLightStack(java.lang.String locationid)
Sends an accept message to the light stack at the specified location |
void |
sendApplicationPongPayload(java.lang.String applicationPingPayload)
Send applicationpong payload to Data Capture |
void |
sendLocationMetaData(java.lang.String locationId,
boolean isDelete,
java.util.Map<java.lang.String,java.lang.String> attributes)
This API call will send IBMSensorEvent to the Data Capture Controller. |
void |
sendRejectToLightStack(java.lang.String locationid)
Sends a reject message to the light stack at the specified location |
void |
setControllerMetaData(java.lang.String controllerid,
java.util.HashMap<java.lang.String,java.lang.String> metadata)
Sets the Controller object with given metadata values |
void |
setGPIO(java.lang.String eventType,
java.lang.String locationid,
java.lang.String payloadvalue)
Sets GPIO setting and sends ON/OFF message for given EventType and Location ID |
void |
setLocationMetaData(java.lang.String locationid,
java.util.HashMap<java.lang.String,java.lang.String> metadata)
Sets the Location object with given metadata values |
void |
setLocationMetaDataAndStartLocation(java.lang.String locationid,
java.util.HashMap<java.lang.String,java.lang.String> metadata)
Sets metadata and starts the given location object |
void |
startLocation(java.lang.String locationid)
Sends a start Location command to the given location ID |
void |
stopLocation(java.lang.String locationid)
Sends a stop location command to the given Location |
void |
updateControllerMetaData(java.lang.String controllerid,
java.util.HashMap<java.lang.String,java.lang.String> metadata)
Updates the Controller object with given metadata values |
void |
updateLocationMetaData(java.lang.String locationid,
java.util.HashMap<java.lang.String,java.lang.String> metadata)
Updates the Location object with given metadata values |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SensorEventsAPIAccess()
Method Detail |
---|
protected abstract DeviceConfigAdmin getDeviceConfigAdmin()
protected abstract EPCCommands getEPCCommand()
protected abstract DeviceDataAdmin getDeviceDataAdmin()
protected abstract StatusAdmin getStatusAdmin()
protected abstract DeviceCommandsAdmin getDeviceCommandsAdmin()
protected abstract TagCommissioningAdmin getTagCommissioningAdmin()
protected abstract TagApiAdmin getTagApiAdmin()
public java.lang.String getEpcEncodingfromUrn(java.lang.String urn)
public java.lang.String getPrintJobIdByUrn(java.lang.String urn) throws SensorEventsAPIAccessException
urn
-
SensorEventsAPIAccessException
public java.lang.String getItemReferenceIdByUrn(java.lang.String urn) throws SensorEventsAPIAccessException
urn
-
SensorEventsAPIAccessException
public void sendAcceptToLightStack(java.lang.String locationid) throws SensorEventsAPIAccessException
locationid
- location id of the light stack
SensorEventsAPIAccessException
public void sendRejectToLightStack(java.lang.String locationid) throws SensorEventsAPIAccessException
locationid
- location id of the light stack
SensorEventsAPIAccessException
public void startLocation(java.lang.String locationid) throws SensorEventsAPIAccessException
locationid
- location ID
SensorEventsAPIAccessException
public void stopLocation(java.lang.String locationid) throws SensorEventsAPIAccessException
locationid
- location ID
SensorEventsAPIAccessException
public java.lang.String getDeviceStatus(java.lang.String locationId) throws SensorEventsAPIAccessException
locationId
- location ID of device
SensorEventsAPIAccessException
public java.lang.String printJob(java.lang.String locationid, java.lang.String printerid, PrintDetails pd) throws SensorEventsAPIAccessException
locationid
- location ID of Printer objectprinterid
- printer ID of Printer objectpd
- PrintDetails object
SensorEventsAPIAccessException
public PrintTemplate[] getPrintTemplatesOfType(java.lang.String printerTypeId) throws SensorEventsAPIAccessException
printerTypeId
- the unique ID of the printer type
SensorEventsAPIAccessExceptio
SensorEventsAPIAccessException
public PrintTemplate[] getAllPrintTemplates() throws SensorEventsAPIAccessException
SensorEventsAPIAccessException
public Printer getPrinter(java.lang.String deviceid) throws SensorEventsAPIAccessException
deviceid
- device ID of Printer
SensorEventsAPIAccessException
public Printer[] getAllPrinters() throws SensorEventsAPIAccessException
SensorEventsAPIAccessException
public Device[] getAllDevices() throws SensorEventsAPIAccessException
SensorEventsAPIAccessException
public Device[] getAllDevicesByCategoryName(java.lang.String category) throws SensorEventsAPIAccessException
Device
- Category Name
SensorEventsAPIAccessException
public java.lang.String[] getDeviceIDByCategoryName(java.lang.String category) throws SensorEventsAPIAccessException
Device
- Category Name
SensorEventsAPIAccessException
public Device getDevice(java.lang.String deviceid) throws SensorEventsAPIAccessException
deviceid
- device ID of Reader
SensorEventsAPIAccessException
public Controller[] getAllController() throws SensorEventsAPIAccessException
SensorEventsAPIAccessException
public PassiveRFIDReader[] getAllPassiveRFIDReader() throws SensorEventsAPIAccessException
SensorEventsAPIAccessException
public PassiveRFIDReader getPassiveRFIDReader(java.lang.String id) throws SensorEventsAPIAccessException
SensorEventsAPIAccessException
public Controller getController(java.lang.String controllerid) throws SensorEventsAPIAccessException
controllerid
- unique ID for Controller
SensorEventsAPIAccessException
public Location[] getAllLocation() throws SensorEventsAPIAccessException
SensorEventsAPIAccessException
public Location getLocation(java.lang.String locationid) throws SensorEventsAPIAccessException
locationid
- or location alias for the Location
SensorEventsAPIAccessException
public void setLocationMetaData(java.lang.String locationid, java.util.HashMap<java.lang.String,java.lang.String> metadata) throws SensorEventsAPIAccessException
locationid
- for the Locationmetadata
- for the Location
SensorEventsAPIAccessException
public java.util.HashMap<java.lang.String,java.lang.String> getLocationMetaData(java.lang.String locationid) throws SensorEventsAPIAccessException
locationid
- for the Location
SensorEventsAPIAccessException
public void updateLocationMetaData(java.lang.String locationid, java.util.HashMap<java.lang.String,java.lang.String> metadata) throws SensorEventsAPIAccessException
locationid
- for the Locationmetadata
- for the Location
SensorEventsAPIAccessException
public void deleteLocationMetaData(java.lang.String locationid, java.lang.String keyname) throws SensorEventsAPIAccessException
locationid
- for the Locationkeyname
- for the value to be deleted from the Backend DataBase
SensorEventsAPIAccessException
public void setControllerMetaData(java.lang.String controllerid, java.util.HashMap<java.lang.String,java.lang.String> metadata) throws SensorEventsAPIAccessException
controllerid
- for the Contollermetadata
- for the Controller
SensorEventsAPIAccessException
public java.util.HashMap<java.lang.String,java.lang.String> getControllerMetaData(java.lang.String controllerid) throws SensorEventsAPIAccessException
controllerid
- for the Contoller
SensorEventsAPIAccessException
public void updateControllerMetaData(java.lang.String controllerid, java.util.HashMap<java.lang.String,java.lang.String> metadata) throws SensorEventsAPIAccessException
controllerid
- for the Contollermetadata
- for the Controller
SensorEventsAPIAccessException
public void deleteControllerMetaData(java.lang.String controllerid, java.lang.String keyname) throws SensorEventsAPIAccessException
controllerid
- for the Contollerkeyname
- for the value to be deleted from the Backend DataBase
SensorEventsAPIAccessException
public void setLocationMetaDataAndStartLocation(java.lang.String locationid, java.util.HashMap<java.lang.String,java.lang.String> metadata) throws SensorEventsAPIAccessException
locationid
- for the Locationmetadata
- for the Location
SensorEventsAPIAccessException
public java.lang.String getPremisesPropertiesKeyValue(java.lang.String key) throws SensorEventsAPIAccessException
key
- properties key name
SensorEventsAPIAccessException
public PrinterType getPrinterType(java.lang.String printerTypeId) throws SensorEventsAPIAccessException
printerTypeId
- printer type unique ID
SensorEventsAPIAccessException
public java.lang.String getPrintJobStatus(java.lang.String printJobId) throws SensorEventsAPIAccessException
printJobId
- id
SensorEventsAPIAccessException
public PrintJob getPrintJob(java.lang.String printJobId) throws SensorEventsAPIAccessException
printJobId
- id of print job you are looking for
note: "successfully registered" does not mean "successfully printed".
SensorEventsAPIAccessException
public PrintJob[] getPrintJobs() throws SensorEventsAPIAccessException
note: "successfully registered" does not mean "successfully printed".
SensorEventsAPIAccessException
public SupplyChainProfile[] getSupplyChainProfiles() throws SensorEventsAPIAccessException
SensorEventsAPIAccessExceptionn
SensorEventsAPIAccessException
public SupplyChainProfile getSupplyChainProfile(java.lang.String id) throws SensorEventsAPIAccessException
id
- supply chain profile id
SensorEventsAPIAccessException
public PrintDetails[] getPrintDetailsByBusinessRef(java.lang.String businessRefId) throws SensorEventsAPIAccessException
businessRefId
-
SensorEventsAPIAccessException
public PrintDetails getPrintDetails(java.lang.String printJobId) throws SensorEventsAPIAccessException
printJobId
-
SensorEventsAPIAccessException
public java.lang.String[] getEpcTagData(java.lang.String printJobId) throws SensorEventsAPIAccessException
printJobId
-
SensorEventsAPIAccessException
public java.lang.String[] getEpcTagDataByBusinessRef(java.lang.String businessRef) throws SensorEventsAPIAccessException
businessRef
- business reference id
SensorEventsAPIAccessException
public void clearALEData(java.lang.String location) throws SensorEventsAPIAccessException
location
- location id
SensorEventsAPIAccessException
public ECReports[] getALEData(java.lang.String location) throws SensorEventsAPIAccessException
location
- location id of reader
SensorEventsAPIAccessException
public TagHistoriesForLocationOutput[] getTagHistoriesForLocation(long startDateTime, java.lang.String locationId) throws PremisesAccessException
long
- startDateTimeString
- locationId
SensorEventsAPIAccessException
PremisesAccessException
public TagHistoriesForReaderOutput[] getTagHistoriesForReader(long startDateTime, java.lang.String readerId) throws SensorEventsAPIAccessException
long
- startDateTimeString
- Reader / Device ID
SensorEventsAPIAccessException
public HistoryForTagOutput[] getHistoryForTag(long startDateTime, java.lang.String tag) throws SensorEventsAPIAccessException
long
- startDateTimeString
- EPC Tag ID
SensorEventsAPIAccessException
public java.util.Map<java.lang.String,java.lang.String> decodeEPCValue(java.lang.String epcVal) throws SensorEventsAPIAccessException
EPC
- Hex value as String.
Following are the map key names for the decoded EPC value.
TagType
CompanyPrefix
Filter
Partition
IndividualAssetReference
AssetType
SerialNumber
LocationReference
ExtensionComponent
GeneralManagerNumber
ObjectClass
CAGECode
SerialReference
TagHeader
If given tag does not have any of the mentioned values above in the tag, the map is not going to be populated with the certain key name and value.
SensorEventsAPIAccessException
public void sendLocationMetaData(java.lang.String locationId, boolean isDelete, java.util.Map<java.lang.String,java.lang.String> attributes) throws SensorEventsAPIAccessException
Location
- ID as String.Ture/false
- is API need to send Delete Event to Data Capture Device.Attributes
- as Map to set into the IBMSensorEvent Payload.
SensorEventsAPIAccessException
public void publish(java.lang.String message) throws SensorEventsAPIAccessException
Message
- as XML String.
SensorEventsAPIAccessException
public void publishOutBound(java.lang.String message) throws SensorEventsAPIAccessException
Message
- as XML String.
SensorEventsAPIAccessException
public java.lang.String[] getAllChildLocation(java.lang.String locationid) throws SensorEventsAPIAccessException
location
- id.
SensorEventsAPIAccessException
public java.lang.String[] getAllParentLocation(java.lang.String locationid) throws SensorEventsAPIAccessException
location
- id.
SensorEventsAPIAccessException
public void sendApplicationPongPayload(java.lang.String applicationPingPayload) throws SensorEventsAPIAccessException
application
- ping payload as XML string
SensorEventsAPIAccessException
public void setGPIO(java.lang.String eventType, java.lang.String locationid, java.lang.String payloadvalue) throws SensorEventsAPIAccessException
EventType
- Location
- IDPayload
- value - ON / OFF
SensorEventsAPIAccessException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |