RestWrapper (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.vib.servers.rest.RestWrapper

public class RestWrapper
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String[]`	`PUBLISH_ONLY_TAG_NAMES` The array of classes that need to be published but not subscribed.
`static java.lang.String`	`READ_CONTAINER_NAME` The name of the container holding the variables that will be read.
`static java.lang.String`	`WRITE_CONTAINER_NAME` The name of the container holding the variables that will be written.

Constructor Summary

Constructors
Constructor and Description

RestWrapper()
Default constructor.

Constructors
Constructor and Description
`RestWrapper()` Default constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canReload()` This server responds true.
`void`	`destroy()` Destroy the server.
`DataSourceContainer`	`getRestContainer()`
`DataSourceContainer`	`getRestReadContainer()`
`RESTServiceManager`	`getRestServiceManager()` Return the device server.
`DataSourceContainer`	`getRestWriteContainer()`
`static RestWrapper`	`getServer()` Return the REST server.
`static RestWrapper`	`getWrapper()` Return the wrapper creating as necessary.
`static RestWrapper`	`getWrapper(PersistenceInterface persistence)` Return the wrapper creating as necessary.
`void`	`init()` Create the server.
`void`	`populateServer()` Add all existing tags to the wrapper.
`void`	`populateServer(java.lang.Object dataSourceContainer)` Recursively add all existing tags in the given container to the wrapper.
`void`	`start()` After creating the server, tags should be added to the server.
`void`	`stop()` Stop the server.

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

- Field Detail
  - PUBLISH_ONLY_TAG_NAMES
```
public static final java.lang.String[] PUBLISH_ONLY_TAG_NAMES
```
    The array of classes that need to be published but not subscribed.
  - READ_CONTAINER_NAME
```
public static final java.lang.String READ_CONTAINER_NAME
```
    The name of the container holding the variables that will be read.
    
    See Also:
    
    Constant Field Values
  - WRITE_CONTAINER_NAME
```
public static final java.lang.String WRITE_CONTAINER_NAME
```
    The name of the container holding the variables that will be written.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RestWrapper
```
public RestWrapper()
```
    Default constructor.
- Method Detail
  - canReload
```
public boolean canReload()
```
    This server responds true. REST is stateless and can be reloaded without a MIX restart.
    
    Returns:
    
    false
  - destroy
```
public void destroy()
             throws BadParameterException
```
    Destroy the server. After this there will be no access to this server.
    
    Throws:
    
    BadParameterException
  - getRestContainer
```
public DataSourceContainer getRestContainer()
```
    Returns:
    
    the restContainer
  - getRestReadContainer
```
public DataSourceContainer getRestReadContainer()
```
    Returns:
    
    the restContainer
  - getRestServiceManager
```
public RESTServiceManager getRestServiceManager()
```
    Return the device server.
    
    Returns:
    
    the device server
  - getRestWriteContainer
```
public DataSourceContainer getRestWriteContainer()
```
    Returns:
    
    the restContainer
  - getServer
```
public static RestWrapper getServer()
```
    Return the REST server.
  - getWrapper
```
public static RestWrapper getWrapper()
```
    Return the wrapper creating as necessary.
  - getWrapper
```
public static RestWrapper getWrapper(PersistenceInterface persistence)
```
    Return the wrapper creating as necessary.
  - init
```
public void init()
          throws BadParameterException
```
    Create the server. After the server is created tags should be added to it before it is started.
    
    Throws:
    
    BadParameterException - thrown if the server cannot be created
  - populateServer
```
public void populateServer()
```
    Add all existing tags to the wrapper.
  - populateServer
```
public void populateServer(java.lang.Object dataSourceContainer)
```
    Recursively add all existing tags in the given container to the wrapper.
  - start
```
public void start()
           throws BadParameterException,
                  VIBUpdateFailedException
```
    After creating the server, tags should be added to the server. After that, the server should be started.
    
    Throws:
    
    VIBUpdateFailedException
    
    BadParameterException
  - stop
```
public void stop()
          throws BadParameterException
```
    Stop the server. This currently has no effect.
    
    Throws:
    
    BadParameterException

Class RestWrapper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PUBLISH_ONLY_TAG_NAMES

READ_CONTAINER_NAME

WRITE_CONTAINER_NAME

Constructor Detail

RestWrapper

Method Detail

canReload

destroy

getRestContainer

getRestReadContainer

getRestServiceManager

getRestWriteContainer

getServer

getWrapper

getWrapper

init

populateServer

populateServer

start

stop