com.ibm.rfid.premises.app.access
Class ALEAccess

java.lang.Object
  extended by com.ibm.rfid.premises.app.access.ALEAccess
Direct Known Subclasses:
ALEAccessLocal

public abstract class ALEAccess
extends java.lang.Object

An AleAccess is an abstract class used to access limited ALE functionality on the IBM WebSphere Sensor Events.

Use the method PremisesContext.getALEAccess() to retrieve an AleAccess object.

See Also:
ALEAccessLocal, PremisesContext

Constructor Summary
ALEAccess()
           
 
Method Summary
protected abstract  ALE getALERuntime()
          Gets the local AleSession
 java.lang.String getSpecByReaderId(java.lang.String readerId)
          returns the ale spec name that is using the reader specified by given id returns null if reader is not being used by ALE.
 java.lang.String getTriggerUrlPrefix()
          gets the trigger url prefix used by this Ale client (default: http://localhost:9080/AleHttpAdapters/)
protected  void setTriggerUrlPrefix(java.lang.String s)
          sets the trigger url prefix that this Ale client will use
 void startALESpec(java.lang.String alespecname, java.lang.String id)
          Start an Ale specification.
 void startALESpec(java.lang.String alespecname, java.util.Vector alefilters, java.util.Vector alegroups, java.lang.String location)
           
 void stopALESpec(java.lang.String alespecname, java.lang.String location)
          Stop and Ale specification
 void undefineSpec(java.lang.String specname)
          Gets the remote AleSession
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ALEAccess

public ALEAccess()
Method Detail

getALERuntime

protected abstract ALE getALERuntime()
Gets the local AleSession

Returns:
AleSessionLocal object

undefineSpec

public void undefineSpec(java.lang.String specname)
Gets the remote AleSession


getSpecByReaderId

public java.lang.String getSpecByReaderId(java.lang.String readerId)
returns the ale spec name that is using the reader specified by given id returns null if reader is not being used by ALE.

Parameters:
readerId - reader id in question
Returns:
ale spec name that is using the reader specified by given id

startALESpec

public void startALESpec(java.lang.String alespecname,
                         java.util.Vector alefilters,
                         java.util.Vector alegroups,
                         java.lang.String location)
                  throws ALEAccessException
Parameters:
alespecname - Ale specification name
alefilters - Vector of Ale filters required by Ale engine
alegroups - Vector of Ale groups required by Ale engine
location - String location of target device
Throws:
ALEAccessException

startALESpec

public void startALESpec(java.lang.String alespecname,
                         java.lang.String id)
                  throws ALEAccessException
Start an Ale specification. If a real location is used, tag reads from all readers at that location will be used. If a logical location is used (e.g., P1:R1), then only tag reads from that reader will be used.

Parameters:
alespecname - the name of the Ale specification to start
id - location of the target device (e.g., "P1"), or a logical location (e.g., "P1:R1")
Throws:
ALEAccessException

stopALESpec

public void stopALESpec(java.lang.String alespecname,
                        java.lang.String location)
                 throws ALEAccessException
Stop and Ale specification

Parameters:
alespecname - the name of the Ale specification to stop
location - location of the target device
Throws:
ALEAccessException

getTriggerUrlPrefix

public java.lang.String getTriggerUrlPrefix()
gets the trigger url prefix used by this Ale client (default: http://localhost:9080/AleHttpAdapters/)

Returns:
current trigger url prefix, will return default if null or empty

setTriggerUrlPrefix

protected void setTriggerUrlPrefix(java.lang.String s)
sets the trigger url prefix that this Ale client will use

Parameters:
s - trigger url prefix to set


Copyright © 2005 - 2009 IBM Corp. All Rights Reserved.