ScadaBRAPIImpl

java.lang.Object
- br.org.scadabr.api.ScadaBRAPIImpl

All Implemented Interfaces:: ScadaBRAPI, APIConstants, java.rmi.Remote

public class ScadaBRAPIImpl
extends java.lang.Object
implements ScadaBRAPI, APIConstants

Field Summary

Fields
Modifier and Type Field and Description

private ScadaBRAPIDao dataDao
- Fields inherited from interface br.org.scadabr.api.utils.APIConstants
  ACCESS_DENIED, CONDITION_NOT_IMPLEMENTED, ERROR_OK, INSUFFICIENT_PARAMETER, INVALID_ID, INVALID_PARAMETER, MAX_ACTIVE_EVENTS_RETURN, MAX_BROWSE_TAGS_RETURN, MAX_DATA_HISTORY_RETURN, MAX_EVENTS_HISTORY_RETURN, MAX_READ_DATA_RETURN, NO_READ_TAG, NO_REGISTERED_DATAPOINT, NO_REGISTERED_DATASOURCE, NO_WRITE_TAG, NON_EXISTENT_TAG, THERE_ARE_MORE_RETURN_VALUES, UNKNOW_TAG_NAME, UNSPECIFIED_ERROR

Fields
Modifier and Type	Field and Description
`private ScadaBRAPIDao`	`dataDao`

Constructor Summary

Constructors
Constructor and Description

ScadaBRAPIImpl()

Constructors
Constructor and Description
`ScadaBRAPIImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AckEventsResponse`	`ackEvents(AckEventsParams parameters)` This method attempts to recognize the system's active alarms.
`AnnotateEventResponse`	`annotateEvent(AnnotateEventParams parameters)` This method attempts to write a message on a defined event.
`BrowseDataPointsResponse`	`browseDataPoints(BrowseDataPointsParams parameters)`
`BrowseDataSourcesResponse`	`browseDataSources(BrowseDataSourcesParams parameters)`
`BrowseEventsResponse`	`browseEventsDefinitions(BrowseEventsParams parameters)` This method attempts to return system event's definitions.
`BrowseFlexProjectsResponse`	`browseFlexProjects()`
`BrowseTagsResponse`	`browseTags(BrowseTagsParams parameters)` This method attempts to return all or just some registered TAGs specified in itemList.
`ConfigureDataPointResponse`	`configureDataPoint(ConfigureDataPointParams parameters)`
`ConfigureDataSourceResponse`	`configureDataSource(ConfigureDataSourceParams parameters)`
`GetActiveEventsResponse`	`getActiveEvents(GetActiveEventsParams parameters)` This method attempts to return system's active alarms .
`GetDataHistoryResponse`	`getDataHistory(GetDataHistoryParams parameters)` This method attempts to collect data from a defined TAG.
`GetEventsHistoryResponse`	`getEventsHistory(GetEventsHistoryParams parameters)` This method attempts to return a alarm historian of notifications yet recongnized.
`GetFlexBuilderConfigResponse`	`getFlexBuilderConfig(int projectId)`
`GetStatusResponse`	`getStatus()` This method attempts to return a `GetStatusResponse` object containing basic information about the host server, such as software version, start up time, etc.
`private java.util.List<?>`	`limit(java.util.List<?> list, int limitSize)`
`ReadDataResponse`	`readData(ReadDataParams parameters)` This method attempts to read the value of one or more registered TAGs.
`RemoveDataPointResponse`	`removeDataPoint(RemoveDataPointParams parameters)`
`RemoveDataSourceResponse`	`removeDataSource(RemoveDataSourceParams parameters)`
`RemoveFlexProjectResponse`	`removeFlexProject(int id)`
`SetFlexBuilderConfigResponse`	`setFlexBuilderConfig(SetFlexBuilderConfigParams params)`
`WriteDataResponse`	`writeData(WriteDataParams parameters)` This method attempts to write one or more values on registered TAGs.
`WriteStringDataResponse`	`writeStringData(WriteStringDataParams parameters)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - dataDao
```
private ScadaBRAPIDao dataDao
```
- Constructor Detail
  - ScadaBRAPIImpl
```
public ScadaBRAPIImpl()
```
- Method Detail
  - getStatus
```
public GetStatusResponse getStatus()
                            throws java.rmi.RemoteException
```
    This method attempts to return a GetStatusResponse object containing basic information about the host server, such as software version, start up time, etc.
    
    Specified by:
    
    getStatus in interface ScadaBRAPI
    
    Returns:
    
    GetStatusResponse(ReplyBase, ServerStatus )
    
    Throws:
    
    java.rmi.RemoteException
    
    Since:
    
    0.2
    
    See Also:
    
    GetStatusResponse, ReplyBase, ServerStatus, ServerStateCode
  - readData
```
public ReadDataResponse readData(ReadDataParams parameters)
                          throws java.rmi.RemoteException
```
    This method attempts to read the value of one or more registered TAGs. To read the value of one or more determinated TAGs just set the TAG's name on "itemsPath". As a return option, the maximum's return value "maxReturn" can be settable.
    
    Specified by:
    
    readData in interface ScadaBRAPI
    
    Parameters:
    
    {@link - ReadDataParams}(String[] itemPathList, RequestOptions options)
    
    Returns:
    
    ReadDataResponse(ReplyBase, ItemValue[], APIError[] )
    
    Throws:
    
    java.rmi.RemoteException
    
    Since:
    
    0.2
    
    See Also:
    
    ReadDataResponse, ReplyBase, ItemValue, APIError
  - writeData
```
public WriteDataResponse writeData(WriteDataParams parameters)
                            throws java.rmi.RemoteException
```
    This method attempts to write one or more values on registered TAGs. To write, just set the name and value of each ItemValue that will be wrote on each TAG. As a return option, the values wrote on each TAG can be settable to return or not "returnItemValues".
    
    Specified by:
    
    writeData in interface ScadaBRAPI
    
    Parameters:
    
    {@link - WriteDataParams}(ItemValue[] itemsList, WriteDataOptions options)
    
    Returns:
    
    WriteDataResponse(ReplyBase, ItemValue , APIError )
    
    Throws:
    
    java.rmi.RemoteException
    
    Since:
    
    0.2
    
    See Also:
    
    WriteDataResponse, APIError, ItemValue, ReplyBase
  - writeStringData
```
public WriteStringDataResponse writeStringData(WriteStringDataParams parameters)
                                        throws java.rmi.RemoteException
```
    Specified by:
    
    writeStringData in interface ScadaBRAPI
    
    Throws:
    
    java.rmi.RemoteException
  - browseTags
```
public BrowseTagsResponse browseTags(BrowseTagsParams parameters)
                              throws java.rmi.RemoteException
```
    This method attempts to return all or just some registered TAGs specified in itemList. To return defined TAGs just set the itemList with the desired path. Oherwise, all TAGs will be returned. As a return option, the return's maximum value is settable.
    
    Specified by:
    
    browseTags in interface ScadaBRAPI
    
    Parameters:
    
    {@link - BrowseTagsParams}(String itemsPath, BrowseTagsOptions options)
    
    Returns:
    
    WriteDataResponse(ReplyBase,APIError )
    
    Throws:
    
    java.rmi.RemoteException
    
    Since:
    
    0.2
    
    See Also:
    
    BrowseTagsResponse, APIError, ReplyBase
  - getDataHistory
```
public GetDataHistoryResponse getDataHistory(GetDataHistoryParams parameters)
                                      throws java.rmi.RemoteException
```
    This method attempts to collect data from a defined TAG. To collect data, is needed determinate a time interval, setting a initial date and a final date. A maximum value can be defined as a option.
    
    Specified by:
    
    getDataHistory in interface ScadaBRAPI
    
    Parameters:
    
    {@link - GetDataHistoryParams}(String itemName, GetDataHistoryOptions options)
    
    Returns:
    
    GetDataHistoryResponse(ReplyBase, ItemValue , APIError, boolean moreValues )
    
    Throws:
    
    java.rmi.RemoteException
    
    Since:
    
    0.2
    
    See Also:
    
    GetDataHistoryResponse, APIError, ItemValue, ReplyBase
  - getActiveEvents
```
public GetActiveEventsResponse getActiveEvents(GetActiveEventsParams parameters)
                                        throws java.rmi.RemoteException
```
    This method attempts to return system's active alarms . To define the desired alarm level, just set alarm level "alarmLevel" (the above levels are returned too), otherwise, all alarms will be returned. Another stuff that can be settable is the maximum's value return.
    
    Specified by:
    
    getActiveEvents in interface ScadaBRAPI
    
    Parameters:
    
    {@link - GetActiveEventsParams}(String eventsPath, ActiveEventsOptions options)
    
    Returns:
    
    GetActiveEventsResponse(ReplyBase, EventNotification , APIError )
    
    Throws:
    
    java.rmi.RemoteException
    
    Since:
    
    0.2
    
    See Also:
    
    GetActiveEventsResponse, APIError, EventNotification, ReplyBase
  - ackEvents
```
public AckEventsResponse ackEvents(AckEventsParams parameters)
                            throws java.rmi.RemoteException
```
    This method attempts to recognize the system's active alarms. To recognize a specified alarm is passed a event ID "eventsIds" that wants to be recognized. As another option, can be defined if the recognize's event details will be returned, "returnEventDetails".
    
    Specified by:
    
    ackEvents in interface ScadaBRAPI
    
    Parameters:
    
    {@link - AckEventsParams}(Integer[] eventsId, AckEventsOptions options)
    
    Returns:
    
    WriteDataResponse(ReplyBase, EventNotification , APIError )
    
    Throws:
    
    java.rmi.RemoteException
    
    Since:
    
    0.2
    
    See Also:
    
    AckEventsResponse, APIError, EventNotification, ReplyBase
  - getEventsHistory
```
public GetEventsHistoryResponse getEventsHistory(GetEventsHistoryParams parameters)
                                          throws java.rmi.RemoteException
```
    This method attempts to return a alarm historian of notifications yet recongnized. To return that, is needed determinate a time interval, setting a initial date and a final date. To define the desired alarm level, just set alarm level "alarmLevel" (the above levels are returned too), otherwise, all alarms will be returned. Another stuff that can be settable is the maximum's value return.
    
    Specified by:
    
    getEventsHistory in interface ScadaBRAPI
    
    Parameters:
    
    {@link - GetEventsHistoryParams}(String eventsPath, EventsHistoryOptions options)
    
    Returns:
    
    WriteDataResponse(ReplyBase, EventNotification , APIError )
    
    Throws:
    
    java.rmi.RemoteException
    
    Since:
    
    0.2
    
    See Also:
    
    GetEventsHistoryResponse, APIError, EventNotification, ReplyBase
  - browseEventsDefinitions
```
public BrowseEventsResponse browseEventsDefinitions(BrowseEventsParams parameters)
                                             throws java.rmi.RemoteException
```
    This method attempts to return system event's definitions. To return determinate type just set the event type "eventType" to the wished type. If not, will be returned all. As another option, to return specified options of each event just set "returnEventsConfig".
    
    Specified by:
    
    browseEventsDefinitions in interface ScadaBRAPI
    
    Parameters:
    
    {@link - BrowseEventsParams}(String eventsPath, BrowseEventsOptions options)
    
    Returns:
    
    BrowseEventsResponse(ReplyBase, EventDefinition , APIError )
    
    Throws:
    
    java.rmi.RemoteException
    
    Since:
    
    0.2
    
    See Also:
    
    BrowseEventsResponse, APIError, EventDefinition, ReplyBase
  - annotateEvent
```
public AnnotateEventResponse annotateEvent(AnnotateEventParams parameters)
                                    throws java.rmi.RemoteException
```
    This method attempts to write a message on a defined event. To annote a message on a event just pass the event's ID and a message to be attached on it.
    
    Specified by:
    
    annotateEvent in interface ScadaBRAPI
    
    Parameters:
    
    {@link - AnnotateEventParams}(Integer eventId, EventMessage message)
    
    Returns:
    
    AnnotateEventResponse(ReplyBase, EventMessage , APIError )
    
    Throws:
    
    java.rmi.RemoteException
    
    Since:
    
    0.2
    
    See Also:
    
    AnnotateEventResponse, APIError, EventMessage, ReplyBase
  - browseDataSources
```
public BrowseDataSourcesResponse browseDataSources(BrowseDataSourcesParams parameters)
                                            throws java.rmi.RemoteException
```
    Specified by:
    
    browseDataSources in interface ScadaBRAPI
    
    Throws:
    
    java.rmi.RemoteException
  - configureDataSource
```
public ConfigureDataSourceResponse configureDataSource(ConfigureDataSourceParams parameters)
                                                throws java.rmi.RemoteException
```
    Specified by:
    
    configureDataSource in interface ScadaBRAPI
    
    Throws:
    
    java.rmi.RemoteException
  - removeDataSource
```
public RemoveDataSourceResponse removeDataSource(RemoveDataSourceParams parameters)
                                          throws java.rmi.RemoteException
```
    Specified by:
    
    removeDataSource in interface ScadaBRAPI
    
    Throws:
    
    java.rmi.RemoteException
  - browseDataPoints
```
public BrowseDataPointsResponse browseDataPoints(BrowseDataPointsParams parameters)
                                          throws java.rmi.RemoteException
```
    Specified by:
    
    browseDataPoints in interface ScadaBRAPI
    
    Throws:
    
    java.rmi.RemoteException
  - configureDataPoint
```
public ConfigureDataPointResponse configureDataPoint(ConfigureDataPointParams parameters)
                                              throws java.rmi.RemoteException
```
    Specified by:
    
    configureDataPoint in interface ScadaBRAPI
    
    Throws:
    
    java.rmi.RemoteException
  - removeDataPoint
```
public RemoveDataPointResponse removeDataPoint(RemoveDataPointParams parameters)
                                        throws java.rmi.RemoteException
```
    Specified by:
    
    removeDataPoint in interface ScadaBRAPI
    
    Throws:
    
    java.rmi.RemoteException
  - limit
```
private java.util.List<?> limit(java.util.List<?> list,
                                int limitSize)
```
  - getFlexBuilderConfig
```
public GetFlexBuilderConfigResponse getFlexBuilderConfig(int projectId)
                                                  throws java.rmi.RemoteException
```
    Specified by:
    
    getFlexBuilderConfig in interface ScadaBRAPI
    
    Throws:
    
    java.rmi.RemoteException
  - browseFlexProjects
```
public BrowseFlexProjectsResponse browseFlexProjects()
                                              throws java.rmi.RemoteException
```
    Specified by:
    
    browseFlexProjects in interface ScadaBRAPI
    
    Throws:
    
    java.rmi.RemoteException
  - setFlexBuilderConfig
```
public SetFlexBuilderConfigResponse setFlexBuilderConfig(SetFlexBuilderConfigParams params)
                                                  throws java.rmi.RemoteException
```
    Specified by:
    
    setFlexBuilderConfig in interface ScadaBRAPI
    
    Throws:
    
    java.rmi.RemoteException
  - removeFlexProject
```
public RemoveFlexProjectResponse removeFlexProject(int id)
                                            throws java.rmi.RemoteException
```
    Specified by:
    
    removeFlexProject in interface ScadaBRAPI
    
    Throws:
    
    java.rmi.RemoteException

Class ScadaBRAPIImpl

Field Summary

Fields inherited from interface br.org.scadabr.api.utils.APIConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dataDao

Constructor Detail

ScadaBRAPIImpl

Method Detail

getStatus

readData

writeData

writeStringData

browseTags

getDataHistory

getActiveEvents

ackEvents

getEventsHistory

browseEventsDefinitions

annotateEvent

browseDataSources

configureDataSource

removeDataSource

browseDataPoints

configureDataPoint

removeDataPoint

limit

getFlexBuilderConfig

browseFlexProjects

setFlexBuilderConfig

removeFlexProject