|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.rfid.premises.app.access.PremisesAccess
#SensorEventsAPIAccess
@Deprecated public abstract class PremisesAccess
Constructor Summary | |
---|---|
PremisesAccess()
Deprecated. |
Method Summary | |
---|---|
void |
clearALEData(java.lang.String location)
Deprecated. clears the ALE Data for a given location |
java.util.Map |
decodeEPCValue(java.lang.String epcVal)
Deprecated. Decodes given EPC Hex value and retrun map for all the decoded values. |
void |
deleteControllerMetaData(java.lang.String controllerid,
java.lang.String keyname)
Deprecated. Deletes the metadata key and value for the given Controller object |
void |
deleteLocationMetaData(java.lang.String locationid,
java.lang.String keyname)
Deprecated. Deletes the metadata key and value for the given Location object |
ECReports[] |
getALEData(java.lang.String location)
Deprecated. gets the ECReports for a given location/reader |
Controller[] |
getAllController()
Deprecated. Gets all Controller objects defined in the IBM WebSphere Sensor Events Server |
Device[] |
getAllDevices()
Deprecated. Gets all Device objects defined in the IBM WebSphere Sensor Events Server |
Device[] |
getAllDevicesByCategoryName(java.lang.String category)
Deprecated. Gets all Device objects defined in the IBM WebSphere Sensor Events Server for given Device Category |
Location[] |
getAllLocation()
Deprecated. Gets all Location objects defined in the IBM WebSphere Sensor Events Server |
Printer[] |
getAllPrinters()
Deprecated. Gets all printers defined in the IBM WebSphere Sensor Events Server |
PrintTemplate[] |
getAllPrintTemplates()
Deprecated. Gets all of the print templates |
Reader[] |
getAllReaders()
Deprecated. see getAllDevice method |
Controller |
getController(java.lang.String controllerid)
Deprecated. Gets the Controller object with the specified Controller ID |
java.util.HashMap |
getControllerMetaData(java.lang.String controllerid)
Deprecated. Gets the metdadata values for given Controller |
Device |
getDevice(java.lang.String deviceid)
Deprecated. Gets the Device with the specified device ID |
protected abstract DeviceCommandsAdmin |
getDeviceCommandsAdmin()
Deprecated. Gets an object used to send device commands |
protected abstract DeviceConfigAdmin |
getDeviceConfigAdmin()
Deprecated. Gets an object used to get device configuration |
protected abstract DeviceDataAdmin |
getDeviceDataAdmin()
Deprecated. Gets an object used to get device data |
java.lang.String[] |
getDeviceIDByCategoryName(java.lang.String category)
Deprecated. Gets all Device objects defined in the IBM WebSphere Sensor Events Server for given Device Category |
java.lang.String |
getDeviceStatus(java.lang.String locationId)
Deprecated. Gets the device status |
protected abstract EPCCommands |
getEPCCommand()
Deprecated. |
java.lang.String |
getEpcEncodingfromUrn(java.lang.String urn)
Deprecated. 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)
Deprecated. Gets the EPC Tag Data for a specific print job |
java.lang.String[] |
getEpcTagDataByBusinessRef(java.lang.String businessRef)
Deprecated. Gets the EPC Tag Data for a specific business reference |
HistoryForTagOutput[] |
getHistoryForTag(long startDateTime,
java.lang.String tag)
Deprecated. |
java.lang.String |
getItemReferenceIdByUrn(java.lang.String urn)
Deprecated. Gets an item reference from IBM WebSphere Sensor Events Server based on human readable epc urn e.g., "sgtin-64:0.1234567.100110.1" note: urns stored in IBM WebSphere Sensor Events Server are prepended with "urn:epc:tag:". |
Location |
getLocation(java.lang.String locationid)
Deprecated. Gets the Location object with the specified Location ID or Location Alias |
java.util.HashMap |
getLocationMetaData(java.lang.String locationid)
Deprecated. Gets the metadata values for given Location |
java.lang.String |
getPremisesPropertiesKeyValue(java.lang.String key)
Deprecated. Gets the key value from premises.properties (default location is - IBM_RFID_HOME\premises\properties) |
PrintDetails |
getPrintDetails(java.lang.String printJobId)
Deprecated. Gets the PrintDetails for a specific print job |
PrintDetails[] |
getPrintDetailsByBusinessRef(java.lang.String businessRefId)
Deprecated. Gets the PrintDetails using a specified business reference ID |
Printer |
getPrinter(java.lang.String deviceid)
Deprecated. Gets the printer with the specified device ID |
PrinterType |
getPrinterType(java.lang.String printerTypeId)
Deprecated. Gets the PrinterType using the specified printer type ID |
PrintJob |
getPrintJob(java.lang.String printJobId)
Deprecated. Get registered print job |
java.lang.String |
getPrintJobIdByUrn(java.lang.String urn)
Deprecated. Gets a print job id from IBM WebSphere Sensor Events Server based on human readable epc urn e.g., "sgtin-64:0.1234567.100110.1" note: urns stored in IBM WebSphere Sensor Events Server are prepended with "urn:epc:tag:". |
PrintJob[] |
getPrintJobs()
Deprecated. Get all of the print jobs that have been registered. |
java.lang.String |
getPrintJobStatus(java.lang.String printJobId)
Deprecated. |
PrintTemplate[] |
getPrintTemplatesOfType(java.lang.String printerTypeId)
Deprecated. Gets the Print templates of the specified type |
Reader |
getReader(java.lang.String deviceid)
Deprecated. see getDevice method |
java.lang.String |
getReaderStatus(java.lang.String locationId)
Deprecated. see getDeviceStatus method |
ReaderType |
getReaderType(java.lang.String readerTypeId)
Deprecated. Gets the ReaderType using the specified reader type ID |
protected abstract StatusAdmin |
getStatusAdmin()
Deprecated. Gets an object used to get device and job status |
SupplyChainProfile |
getSupplyChainProfile(java.lang.String id)
Deprecated. Gets the SupplyChainProfile with a specified ID |
SupplyChainProfile[] |
getSupplyChainProfiles()
Deprecated. Gets all of the SupplyChainProfiles that are currently defined |
protected abstract TagApiAdmin |
getTagApiAdmin()
Deprecated. Gets an object used to query the IBM WebSphere Sensor Events Server tag history |
protected abstract TagCommissioningAdmin |
getTagCommissioningAdmin()
Deprecated. Gets an object used to interact with tag commissioning functions |
TagHistoriesForLocationOutput[] |
getTagHistoriesForLocation(long startDateTime,
java.lang.String locationId)
Deprecated. |
TagHistoriesForReaderOutput[] |
getTagHistoriesForReader(long startDateTime,
java.lang.String readerId)
Deprecated. |
java.lang.String |
printJob(java.lang.String locationid,
java.lang.String printerid,
PrintDetails pd)
Deprecated. Sends a print job command to the IBM WebSphere Sensor Events |
void |
sendAcceptToLightStack(java.lang.String locationid)
Deprecated. Sends an accept message to the light stack at the specified location |
void |
sendLocationMetaData(java.lang.String locationId,
boolean isDelete,
java.util.Map attributes)
Deprecated. This API call will send IBMSensorEvent to the Data Capture Controller. |
void |
sendRejectToLightStack(java.lang.String locationid)
Deprecated. Sends a reject message to the light stack at the specified location |
void |
setControllerMetaData(java.lang.String controllerid,
java.util.HashMap metadata)
Deprecated. Sets the Controller object with given metadata values |
void |
setLocationMetaData(java.lang.String locationid,
java.util.HashMap metadata)
Deprecated. Sets the Location object with given metadata values |
void |
setLocationMetaDataAndStartLocation(java.lang.String locationid,
java.util.HashMap metadata)
Deprecated. Sets metadata and starts the given location object |
void |
startLocation(java.lang.String locationid)
Deprecated. Sends a start Location command to the given location ID |
void |
stopLocation(java.lang.String locationid)
Deprecated. Sends a stop location command to the given Location |
void |
turnDeviceOff(java.lang.String locationid,
java.lang.String deviceid)
Deprecated. see stopLocation method |
void |
turnDeviceOn(java.lang.String locationid,
java.lang.String deviceid)
Deprecated. see startLocation method |
void |
turnReaderOff(java.lang.String locationid,
java.lang.String deviceid)
Deprecated. see stopLocation method |
void |
turnReaderOn(java.lang.String locationid,
java.lang.String deviceid)
Deprecated. see startLocation method |
void |
updateControllerMetaData(java.lang.String controllerid,
java.util.HashMap metadata)
Deprecated. Updates the Controller object with given metadata values |
void |
updateLocationMetaData(java.lang.String locationid,
java.util.HashMap metadata)
Deprecated. 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 PremisesAccess()
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 PremisesAccessException
urn
-
PremisesAccessException
public java.lang.String getItemReferenceIdByUrn(java.lang.String urn) throws PremisesAccessException
urn
-
PremisesAccessException
public void sendAcceptToLightStack(java.lang.String locationid) throws PremisesAccessException
locationid
- location id of the light stack
PremisesAccessException
public void sendRejectToLightStack(java.lang.String locationid) throws PremisesAccessException
locationid
- location id of the light stack
PremisesAccessException
public void turnReaderOn(java.lang.String locationid, java.lang.String deviceid) throws PremisesAccessException
locationid
- location ID of Readerdeviceid
- device ID of Reader
PremisesAccessException
public void turnDeviceOn(java.lang.String locationid, java.lang.String deviceid) throws PremisesAccessException
locationid
- location ID of Devicedeviceid
- device ID of Device
PremisesAccessException
public void startLocation(java.lang.String locationid) throws PremisesAccessException
locationid
- location ID
PremisesAccessException
public void turnReaderOff(java.lang.String locationid, java.lang.String deviceid) throws PremisesAccessException
locationid
- location ID of Readerdeviceid
- Device ID of Reader
PremisesAccessException
public void turnDeviceOff(java.lang.String locationid, java.lang.String deviceid) throws PremisesAccessException
locationid
- location ID for the Devicedeviceid
- Device ID
PremisesAccessException
public void stopLocation(java.lang.String locationid) throws PremisesAccessException
locationid
- location ID
PremisesAccessException
public java.lang.String getReaderStatus(java.lang.String locationId) throws PremisesAccessException
locationId
- location ID of Reader
PremisesAccessException
public java.lang.String getDeviceStatus(java.lang.String locationId) throws PremisesAccessException
locationId
- location ID of device
PremisesAccessException
public java.lang.String printJob(java.lang.String locationid, java.lang.String printerid, PrintDetails pd) throws PremisesAccessException
locationid
- location ID of Printer objectprinterid
- printer ID of Printer objectpd
- PrintDetails object
PremisesAccessException
public PrintTemplate[] getPrintTemplatesOfType(java.lang.String printerTypeId) throws PremisesAccessException
printerTypeId
- the unique ID of the printer type
PremisesAccessException
public PrintTemplate[] getAllPrintTemplates() throws PremisesAccessException
PremisesAccessException
public Reader getReader(java.lang.String deviceid) throws PremisesAccessException
deviceid
- device ID of Reader
PremisesAccessException
public Printer getPrinter(java.lang.String deviceid) throws PremisesAccessException
deviceid
- device ID of Printer
PremisesAccessException
public Printer[] getAllPrinters() throws PremisesAccessException
PremisesAccessException
public Reader[] getAllReaders() throws PremisesAccessException
PremisesAccessException
public Device[] getAllDevices() throws PremisesAccessException
PremisesAccessException
public Device[] getAllDevicesByCategoryName(java.lang.String category) throws PremisesAccessException
Device
- Category Name
PremisesAccessException
public java.lang.String[] getDeviceIDByCategoryName(java.lang.String category) throws PremisesAccessException
Device
- Category Name
PremisesAccessException
public Device getDevice(java.lang.String deviceid) throws PremisesAccessException
deviceid
- device ID of Reader
PremisesAccessException
public Controller[] getAllController() throws PremisesAccessException
PremisesAccessException
public Controller getController(java.lang.String controllerid) throws PremisesAccessException
controllerid
- unique ID for Controller
PremisesAccessException
public Location[] getAllLocation() throws PremisesAccessException
PremisesAccessException
public Location getLocation(java.lang.String locationid) throws PremisesAccessException
locationid
- or location alias for the Location
PremisesAccessException
public void setLocationMetaData(java.lang.String locationid, java.util.HashMap metadata) throws PremisesAccessException
locationid
- for the Locationmetadata
- for the Location
PremisesAccessException
public java.util.HashMap getLocationMetaData(java.lang.String locationid) throws PremisesAccessException
locationid
- for the Location
PremisesAccessException
public void updateLocationMetaData(java.lang.String locationid, java.util.HashMap metadata) throws PremisesAccessException
locationid
- for the Locationmetadata
- for the Location
PremisesAccessException
public void deleteLocationMetaData(java.lang.String locationid, java.lang.String keyname) throws PremisesAccessException
locationid
- for the Locationkeyname
- for the vlaue to be deleted from the Backend DataBase
PremisesAccessException
public void setControllerMetaData(java.lang.String controllerid, java.util.HashMap metadata) throws PremisesAccessException
controllerid
- for the Contollermetadata
- for the Controller
PremisesAccessException
public java.util.HashMap getControllerMetaData(java.lang.String controllerid) throws PremisesAccessException
controllerid
- for the Contoller
PremisesAccessException
public void updateControllerMetaData(java.lang.String controllerid, java.util.HashMap metadata) throws PremisesAccessException
controllerid
- for the Contollermetadata
- for the Controller
PremisesAccessException
public void deleteControllerMetaData(java.lang.String controllerid, java.lang.String keyname) throws PremisesAccessException
controllerid
- for the Contollerkeyname
- for the vlaue to be deleted from the Backend DataBase
PremisesAccessException
public void setLocationMetaDataAndStartLocation(java.lang.String locationid, java.util.HashMap metadata) throws PremisesAccessException
locationid
- for the Locationmetadata
- for the Location
PremisesAccessException
public java.lang.String getPremisesPropertiesKeyValue(java.lang.String key) throws PremisesAccessException
key
- properties key name
PremisesAccessException
public PrinterType getPrinterType(java.lang.String printerTypeId) throws PremisesAccessException
printerTypeId
- printer type unique ID
PremisesAccessException
public ReaderType getReaderType(java.lang.String readerTypeId) throws PremisesAccessException
readerTypeId
- reader type unique ID
PremisesAccessException
public java.lang.String getPrintJobStatus(java.lang.String printJobId) throws PremisesAccessException
PremisesAccessException
public PrintJob getPrintJob(java.lang.String printJobId) throws PremisesAccessException
printJobId
- id of print job you are looking for
note: "successfully registered" does not mean "successfully printed".
PremisesAccessException
public PrintJob[] getPrintJobs() throws PremisesAccessException
note: "successfully registered" does not mean "successfully printed".
PremisesAccessException
public SupplyChainProfile[] getSupplyChainProfiles() throws PremisesAccessException
PremisesAccessException
public SupplyChainProfile getSupplyChainProfile(java.lang.String id) throws PremisesAccessException
id
- supply chain profile id
PremisesAccessException
public PrintDetails[] getPrintDetailsByBusinessRef(java.lang.String businessRefId) throws PremisesAccessException
businessRefId
-
PremisesAccessException
public PrintDetails getPrintDetails(java.lang.String printJobId) throws PremisesAccessException
printJobId
-
PremisesAccessException
public java.lang.String[] getEpcTagData(java.lang.String printJobId) throws PremisesAccessException
printJobId
-
PremisesAccessException
- the printJobIdpublic java.lang.String[] getEpcTagDataByBusinessRef(java.lang.String businessRef) throws PremisesAccessException
businessRef
- business reference id
PremisesAccessException
public void clearALEData(java.lang.String location) throws PremisesAccessException
location
- location id
PremisesAccessException
public ECReports[] getALEData(java.lang.String location) throws PremisesAccessException
location
- location id of reader
PremisesAccessException
public TagHistoriesForLocationOutput[] getTagHistoriesForLocation(long startDateTime, java.lang.String locationId) throws PremisesAccessException
PremisesAccessException
public TagHistoriesForReaderOutput[] getTagHistoriesForReader(long startDateTime, java.lang.String readerId) throws PremisesAccessException
PremisesAccessException
public HistoryForTagOutput[] getHistoryForTag(long startDateTime, java.lang.String tag) throws PremisesAccessException
PremisesAccessException
public java.util.Map decodeEPCValue(java.lang.String epcVal) throws PremisesAccessException
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.
PremisesAccessException
public void sendLocationMetaData(java.lang.String locationId, boolean isDelete, java.util.Map attributes) throws PremisesAccessException
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.
PremisesAccessException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |