public class RESTfulInterfaceConnector extends Object implements CallServerService
| Modifier and Type | Field and Description |
|---|---|
static String |
ACTIONS_API |
static String |
ACTIONS_API_TASKS |
static String |
CLASSES_API |
static String |
ENTITIES_API |
static String |
NODES_API |
static String |
SEARCH_API |
static String |
SEARCH_API_RESULTS |
static String |
USERS_API |
| Constructor and Description |
|---|
RESTfulInterfaceConnector(String rootResource)
Creates a new RESTfulInterfaceConnector object.
|
RESTfulInterfaceConnector(String rootResource,
de.cismet.netutil.Proxy proxy)
Creates a new RESTfulInterfaceConnector object.
|
RESTfulInterfaceConnector(String rootResource,
de.cismet.netutil.Proxy proxy,
SSLConfig sslConfig)
Creates a new RESTfulInterfaceConnector object.
|
RESTfulInterfaceConnector(String rootResource,
SSLConfig sslConfig)
Creates a new RESTfulInterfaceConnector object.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
addLink(Node from,
Node to,
User user)
Deprecated.
|
boolean |
addLink(Node from,
Node to,
User user,
de.cismet.connectioncontext.ConnectionContext connectionContext)
TODO: Implement method in Nodes API or remove
|
Node |
addNode(Node node,
Link parent,
User user)
Deprecated.
|
Node |
addNode(Node node,
Link parent,
User user,
de.cismet.connectioncontext.ConnectionContext connectionContext)
TODO: Implement method in Nodes API or remove
|
boolean |
changePassword(User user,
String oldPassword,
String newPassword)
Deprecated.
|
boolean |
changePassword(User user,
String oldPassword,
String newPassword,
de.cismet.connectioncontext.ConnectionContext connectionContext)
TODO: Implement Method in Users API or remove.
|
protected com.sun.jersey.api.client.WebResource.Builder |
createAuthorisationHeader(com.sun.jersey.api.client.WebResource webResource,
User user)
DOCUMENT ME!
|
protected com.sun.jersey.api.client.WebResource.Builder |
createMediaTypeHeaders(com.sun.jersey.api.client.WebResource.Builder builder)
DOCUMENT ME!
|
protected com.sun.jersey.api.client.WebResource.Builder |
createMediaTypeHeaders(com.sun.jersey.api.client.WebResource webResource)
DOCUMENT ME!
|
protected javax.ws.rs.core.MultivaluedMap |
createUserParameters(javax.ws.rs.core.MultivaluedMap queryParams,
User user)
Helper Method for adding 'domain' and 'role' query parameters to an existing query parameters map from a legacy
cids user object.
|
protected javax.ws.rs.core.MultivaluedMap |
createUserParameters(User user)
Helper Method for creating 'domain' and 'role' query parameters from legacy cids user object.
|
protected com.sun.jersey.api.client.WebResource |
createWebResource(String path)
Creates a
WebResource.Builder from the given path and the given params. |
Collection |
customServerSearch(User user,
CidsServerSearch serverSearch)
Deprecated.
|
Collection |
customServerSearch(User user,
CidsServerSearch serverSearch,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Performs a remote server search by submitting a parameterized CidsServerSearch instance.
|
boolean |
deleteLink(Node from,
Node to,
User user)
Deprecated.
|
boolean |
deleteLink(Node from,
Node to,
User user,
de.cismet.connectioncontext.ConnectionContext connectionContext)
TODO: Implement method in Nodes API or remove
|
int |
deleteMetaObject(User user,
MetaObject metaObject,
String domain)
Deprecated.
|
int |
deleteMetaObject(User user,
MetaObject metaObject,
String domain,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Deletes a meta object.
Example REST Call: curl --user username@SWITCHON:password -X DELETE http://localhost:8890/switchon.contact/31337 |
boolean |
deleteNode(Node node,
User user)
Deprecated.
|
boolean |
deleteNode(Node node,
User user,
de.cismet.connectioncontext.ConnectionContext connectionContext)
TODO: Implement method in Nodes API or remove
|
Object |
executeTask(User user,
String taskname,
String domain,
Object body,
de.cismet.connectioncontext.ConnectionContext connectionContext,
ServerActionParameter... params)
Executes a remote task in the connectionContext of the server.
Example REST Call: curl --user admin@SWITCHON:cismet |
Object |
executeTask(User user,
String taskname,
String domain,
Object body,
ServerActionParameter... params)
Deprecated.
|
LightweightMetaObject[] |
getAllLightweightMetaObjectsForClass(int classId,
User user,
String[] representationFields)
Deprecated.
|
LightweightMetaObject[] |
getAllLightweightMetaObjectsForClass(int classId,
User user,
String[] representationFields,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Returns all LightweightMetaObject of the class specified by classId.
|
LightweightMetaObject[] |
getAllLightweightMetaObjectsForClass(int classId,
User user,
String[] representationFields,
String representationPattern)
Deprecated.
|
LightweightMetaObject[] |
getAllLightweightMetaObjectsForClass(int classId,
User user,
String[] representationFields,
String representationPattern,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Returns all LightweightMetaObject of the class specified by classId.
|
protected String |
getBasicAuthString(User user)
Tries to lookup a basic auth string for a previously authenticated user FIXME: better work with session ids, etc.
|
Node[] |
getChildren(Node node,
User user)
Deprecated.
|
Node[] |
getChildren(Node node,
User user,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Gets the children of the specified node for the specified user.
|
MetaClass |
getClass(User user,
int classId,
String domain)
Deprecated.
|
MetaClass |
getClass(User user,
int classId,
String domain,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Gets a meta class by its legacy class id (int) for the user form the specified domain.
|
MetaClass |
getClassByTableName(User user,
String tableName,
String domain)
Deprecated.
|
MetaClass |
getClassByTableName(User user,
String tableName,
String domain,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Gets a meta class by its name for the user form the specified domain.
|
MetaClass[] |
getClasses(User user,
String domain)
Deprecated.
|
MetaClass[] |
getClasses(User user,
String domain,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Gets all meta classes for the user from the specified the domain.
|
Node[] |
getClassTreeNodes(User user)
Deprecated.
|
Node[] |
getClassTreeNodes(User user,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Deprecated.
ClassTreeNodes no longer supported
|
Node[] |
getClassTreeNodes(User user,
String domain)
Deprecated.
|
Node[] |
getClassTreeNodes(User user,
String domain,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Deprecated.
ClassTreeNodes no longer supported
|
String |
getConfigAttr(User user,
String key)
Deprecated.
|
String |
getConfigAttr(User user,
String key,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Retrieves the value for the given key for the given
User. |
Image[] |
getDefaultIcons()
Deprecated.
|
Image[] |
getDefaultIcons(de.cismet.connectioncontext.ConnectionContext connectionContext)
Deprecated.
should not return binary images!
|
Image[] |
getDefaultIcons(String domain)
Deprecated.
|
Image[] |
getDefaultIcons(String domain,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Deprecated.
should not return binary images!
|
String[] |
getDomains()
Deprecated.
|
String[] |
getDomains(de.cismet.connectioncontext.ConnectionContext connectionContext)
TODO: To be implemented in cids REST Infrastructure API.
|
HistoryObject[] |
getHistory(int classId,
int objectId,
String domain,
User user,
int elements)
Deprecated.
|
HistoryObject[] |
getHistory(int classId,
int objectId,
String domain,
User user,
int elements,
de.cismet.connectioncontext.ConnectionContext connectionContext)
TODO: To be implemented in cids REST Infrastructure API
|
MetaObject |
getInstance(User user,
MetaClass metaClass)
Deprecated.
|
MetaObject |
getInstance(User user,
MetaClass metaClass,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Gets a new empty instance (MetaObject) of the specified MetaClass.
Example REST Call: http://localhost:8890/SWITCHON.RESOURCE/emptyInstance |
LightweightMetaObject[] |
getLightweightMetaObjectsByQuery(int classId,
User user,
String query,
String[] representationFields)
DOCUMENT ME!
|
LightweightMetaObject[] |
getLightweightMetaObjectsByQuery(int classId,
User user,
String query,
String[] representationFields,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Deprecated.
should be replaced by custom search
|
LightweightMetaObject[] |
getLightweightMetaObjectsByQuery(int classId,
User user,
String query,
String[] representationFields,
String representationPattern)
Deprecated.
|
LightweightMetaObject[] |
getLightweightMetaObjectsByQuery(int classId,
User user,
String query,
String[] representationFields,
String representationPattern,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Deprecated.
should be replaced by custom search
|
MetaObject |
getMetaObject(User user,
int objectId,
int classId,
String domain)
Deprecated.
|
MetaObject |
getMetaObject(User user,
int objectId,
int classId,
String domain,
de.cismet.connectioncontext.ConnectionContext connectionContext)
DOCUMENT ME!
|
MetaObject[] |
getMetaObject(User user,
String query)
retrieves Meta data objects with meta data matching sql query (Search).
|
MetaObject[] |
getMetaObject(User user,
String query,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Deprecated.
should be replaced by custom search
|
MetaObject[] |
getMetaObject(User user,
String query,
String domain)
Deprecated.
|
MetaObject[] |
getMetaObject(User user,
String query,
String domain,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Deprecated.
should be replaced by custom search
|
Node |
getMetaObjectNode(User user,
int nodeID,
String domain)
Deprecated.
|
Node |
getMetaObjectNode(User user,
int nodeID,
String domain,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Gets a legacy node by its id.
|
Node[] |
getMetaObjectNode(User user,
String query)
retrieves Meta data objects with meta data matching query (Search) Query not yet defined but will be MetaSQL.
|
Node[] |
getMetaObjectNode(User user,
String query,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Deprecated.
should be replaced by custom search
|
MethodMap |
getMethods(User user)
Deprecated.
|
MethodMap |
getMethods(User user,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Deprecated.
UnsupportedOperation
|
MethodMap |
getMethods(User user,
String localServerName)
Deprecated.
|
MethodMap |
getMethods(User user,
String localServerName,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Deprecated.
UnsupportedOperation
|
Key |
getPublicJwtKey(String domain)
DOCUMENT ME!
|
protected String |
getRootResource()
DOCUMENT ME!
|
Node[] |
getRoots(User user)
Deprecated.
|
Node[] |
getRoots(User user,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Gets all legacy root nodes of all domains supported by the server.
Example REST Call:
http://localhost:8890/nodes?domain=switchon&role=all |
Node[] |
getRoots(User user,
String domainName)
Deprecated.
|
Node[] |
getRoots(User user,
String domainName,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Gets legacy root nodes of a specific domain.
Example REST Call:
http://localhost:8890/nodes?domain=SWITCHON&limit=100&offset=0&role=all |
User |
getUser(String userGroupLsName,
String userGroupName,
String userLsName,
String userName,
String password)
Deprecated.
|
User |
getUser(String userGroupLsName,
String userGroupName,
String userLsName,
String userName,
String password,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Authenticates a user with the specified name and password at the specified domain.
|
Vector |
getUserGroupNames()
Deprecated.
|
Vector |
getUserGroupNames(de.cismet.connectioncontext.ConnectionContext connectionContext)
TODO: Implement Method in Users API or remove.
|
Vector |
getUserGroupNames(String userName,
String lsHome)
Deprecated.
|
Vector |
getUserGroupNames(String userName,
String lsHome,
de.cismet.connectioncontext.ConnectionContext connectionContext)
TODO: Implement Method in Users API or remove.
|
boolean |
hasConfigAttr(User user,
String key)
Deprecated.
|
boolean |
hasConfigAttr(User user,
String key,
de.cismet.connectioncontext.ConnectionContext connectionContext)
TODO: Implement ConfigAttributes API.
|
protected void |
initSSL(SSLConfig sslConfig)
DOCUMENT ME!
|
MetaObject |
insertMetaObject(User user,
MetaObject metaObject,
String domain)
Deprecated.
|
MetaObject |
insertMetaObject(User user,
MetaObject metaObject,
String domain,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Creates a new meta object and returns the resulting instance.
Example REST Call: curl --user username@SWITCHON:password -H "Content-Type: application/json" -X POST -d
"{$self:'/SWITCHON.contact/31337' }" http://localhost:8890/SWITCHON.contact |
protected void |
putBasicAuthString(User user,
String password)
Stores the BasicAuthString for a specific user in the credentials map.
|
protected void |
removeBasicAuthString(User user)
Removes the BasicAuthString for a specific user in the credentials map, e.g.
|
int |
updateMetaObject(User user,
MetaObject metaObject,
String domain)
Deprecated.
|
int |
updateMetaObject(User user,
MetaObject metaObject,
String domain,
de.cismet.connectioncontext.ConnectionContext connectionContext)
Updates an existing meta object.
Example REST Call: curl --user username@SWITCHON:password -H "Content-Type: application/json" -X PUT -d
"{$self:'/SWITCHON.contact/31337' }" http://localhost:8890/SWITCHON.contact/31337 |
public static final String USERS_API
public static final String CLASSES_API
public static final String ENTITIES_API
public static final String NODES_API
public static final String SEARCH_API
public static final String SEARCH_API_RESULTS
public static final String ACTIONS_API
public static final String ACTIONS_API_TASKS
public RESTfulInterfaceConnector(String rootResource)
rootResource - DOCUMENT ME!public RESTfulInterfaceConnector(String rootResource, de.cismet.netutil.Proxy proxy)
rootResource - DOCUMENT ME!proxy - config proxyURL DOCUMENT ME!public RESTfulInterfaceConnector(String rootResource, SSLConfig sslConfig)
rootResource - DOCUMENT ME!sslConfig - DOCUMENT ME!protected final void initSSL(SSLConfig sslConfig)
sslConfig - DOCUMENT ME!IllegalStateException - DOCUMENT ME!protected String getRootResource()
protected com.sun.jersey.api.client.WebResource createWebResource(String path)
WebResource.Builder from the given path and the given params. The given path will be appended
to the root path of this connector, thus shall denote a path relative to the root resource. The given Map
of queryParams will be appended to the query.path - the path relative to the root resourceWebResource ready to perform an operation (GET, POST, PUT...)protected com.sun.jersey.api.client.WebResource.Builder createAuthorisationHeader(com.sun.jersey.api.client.WebResource webResource,
User user)
throws RemoteException
webResource - DOCUMENT ME!user - DOCUMENT ME!RemoteException - DOCUMENT ME!protected com.sun.jersey.api.client.WebResource.Builder createMediaTypeHeaders(com.sun.jersey.api.client.WebResource.Builder builder)
builder - DOCUMENT ME!protected com.sun.jersey.api.client.WebResource.Builder createMediaTypeHeaders(com.sun.jersey.api.client.WebResource webResource)
webResource - DOCUMENT ME!protected javax.ws.rs.core.MultivaluedMap createUserParameters(javax.ws.rs.core.MultivaluedMap queryParams,
User user)
queryParams - existing query parameters that should be extended by this methoduser - legacy cids user objectprotected javax.ws.rs.core.MultivaluedMap createUserParameters(User user)
user - legacy cids user objectprotected String getBasicAuthString(User user) throws RemoteException
user - DOCUMENT ME!RemoteException - DOCUMENT ME!protected void putBasicAuthString(User user, String password) throws RemoteException
user - legacy cids userpassword - password of the userRemoteException - if the login failsprotected void removeBasicAuthString(User user)
user - user object o remove from the credentials mappublic Node[] getRoots(User user, String domainName, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
http://localhost:8890/nodes?domain=SWITCHON&limit=100&offset=0&role=allgetRoots in interface CatalogueServiceuser - legacy user needed for authenticationdomainName - DOCUMENT ME!connectionContext - DOCUMENT ME!RemoteException - if any server error occurs@Deprecated public Node[] getRoots(User user) throws RemoteException
CatalogueServicegetRoots in interface CatalogueServiceuser - DOCUMENT ME!RemoteException - DOCUMENT ME!public Node[] getRoots(User user, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
http://localhost:8890/nodes?domain=switchon&role=allgetRoots in interface CatalogueServiceuser - legacy user needed for authenticationconnectionContext - DOCUMENT ME!RemoteException - if any server error occurs@Deprecated public Node[] getChildren(Node node, User user) throws RemoteException
CatalogueServicegetChildren in interface CatalogueServicenode - DOCUMENT ME!user - DOCUMENT ME!RemoteException - DOCUMENT ME!public Node[] getChildren(Node node, User user, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
http://localhost:8890/nodes/SWITCHON.7/children?limit=100&offset=0&role=allcurl --user username@SWITCHON:password -H "Content-Type: application/json" -X POST -d "SELECT -1 AS id,
taggroup.name, cs_class.id AS class_id, NULL AS object_id, 'N' AS node_type, NULL AS url, csdc.tags(taggroup.id)
AS dynamic_children, FALSE AS sql_sort FROM taggroup, cs_class WHERE cs_class.name = 'taggroup' ORDER BY
taggroup.name;" http://localhost:8890/nodes/SWITCHON/children?limit=100&offset=0&role=allgetChildren in interface CatalogueServicenode - the legacy node that contains either a valid node id or a dynamic children statementsuser - user performing the requestconnectionContext - DOCUMENT ME!RemoteException - if any remote error occurs@Deprecated public Node addNode(Node node, Link parent, User user) throws RemoteException
CatalogueServiceaddNode in interface CatalogueServicenode - usr user tokenparent - nodeID child nodeuser - domain domain that hosts this childRemoteException - server errorpublic Node addNode(Node node, Link parent, User user, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is currently not implemented in the cids REST API, it throws an Unsupported Operation Exception!
addNode in interface CatalogueServicenode - TODOparent - TODOuser - TODOconnectionContext - DOCUMENT ME!RemoteException - TODOUnsupportedOperationException - Unsupported Operation@Deprecated public boolean deleteNode(Node node, User user) throws RemoteException
CatalogueServicedeleteNode in interface CatalogueServicenode - DOCUMENT ME!user - DOCUMENT ME!RemoteException - DOCUMENT ME!public boolean deleteNode(Node node, User user, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is currently not implemented in the cids REST API, it throws an Unsupported Operation Exception!
deleteNode in interface CatalogueServicenode - TODOuser - TODOconnectionContext - DOCUMENT ME!RemoteException - TODOUnsupportedOperationException - always thrown@Deprecated public boolean addLink(Node from, Node to, User user) throws RemoteException
CatalogueServiceaddLink in interface CatalogueServicefrom - DOCUMENT ME!to - DOCUMENT ME!user - DOCUMENT ME!RemoteException - DOCUMENT ME!public boolean addLink(Node from, Node to, User user, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is currently not implemented in the cids REST API, it throws an Unsupported Operation Exception!
addLink in interface CatalogueServicefrom - TODOto - TODOuser - TODOconnectionContext - DOCUMENT ME!RemoteException - TODOUnsupportedOperationException - Unsupported Operation@Deprecated public boolean deleteLink(Node from, Node to, User user) throws RemoteException
CatalogueServicedeleteLink in interface CatalogueServicefrom - DOCUMENT ME!to - DOCUMENT ME!user - DOCUMENT ME!RemoteException - DOCUMENT ME!public boolean deleteLink(Node from, Node to, User user, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is currently not implemented in the cids REST API, it throws an Unsupported Operation Exception!
deleteLink in interface CatalogueServicefrom - TODOto - TODOuser - TODOconnectionContext - DOCUMENT ME!RemoteException - TODOUnsupportedOperationException - always thrown@Deprecated public Node getMetaObjectNode(User user, int nodeID, String domain) throws RemoteException
MetaServicegetMetaObjectNode in interface MetaServiceuser - DOCUMENT ME!nodeID - DOCUMENT ME!domain - DOCUMENT ME!RemoteException - DOCUMENT ME!public Node getMetaObjectNode(User user, int nodeID, String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
http://localhost:8890/nodes/SWITCHON.7getMetaObjectNode in interface MetaServiceuser - legacy usernodeID - id of the legacy nodedomain - domain nameconnectionContext - DOCUMENT ME!RemoteException - DOCUMENT ME!public Node[] getMetaObjectNode(User user, String query) throws RemoteException
MetaServicegetMetaObjectNode in interface MetaServiceuser - DOCUMENT ME!query - DOCUMENT ME!RemoteException - DOCUMENT ME!public Node[] getMetaObjectNode(User user, String query, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
MetaObjectNodesByQuerySearch and thus deprecated.getMetaObjectNode in interface MetaServiceuser - user performing the requestquery - SQL query that returns classId and objectIdconnectionContext - DOCUMENT ME!RemoteException - if any remote error occurs@Deprecated public Node[] getClassTreeNodes(User user) throws RemoteException
MetaServicegetClassTreeNodes in interface MetaServiceuser - DOCUMENT ME!RemoteException - DOCUMENT ME!public Node[] getClassTreeNodes(User user, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is not supported anymore in the cids REST API, it returns an empty result!
getClassTreeNodes in interface MetaServiceuser - parameter is ignoredconnectionContext - DOCUMENT ME!RemoteException - is never thrown@Deprecated public Node[] getClassTreeNodes(User user, String domain) throws RemoteException
MetaServicegetClassTreeNodes in interface MetaServiceuser - DOCUMENT ME!domain - DOCUMENT ME!RemoteException - DOCUMENT ME!public Node[] getClassTreeNodes(User user, String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is not supported anymore in the cids REST API, it returns an empty result!
getClassTreeNodes in interface MetaServiceuser - parameter is ignoreddomain - parameter is ignoredconnectionContext - DOCUMENT ME!RemoteException - is never thrown@Deprecated public MethodMap getMethods(User user) throws RemoteException
MetaServicegetMethods in interface MetaServiceuser - DOCUMENT ME!RemoteException - DOCUMENT ME!@Deprecated public MetaClass getClass(User user, int classId, String domain) throws RemoteException
MetaServicegetClass in interface MetaServiceuser - DOCUMENT ME!classId - DOCUMENT ME!domain - DOCUMENT ME!RemoteException - DOCUMENT ME!public MetaClass getClass(User user, int classId, String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
getClassByTableName(Sirius.server.newuser.User, java.lang.String, java.lang.String).http://localhost:8890/classes/SWITCHON.taggetClass in interface MetaServiceuser - user performing the requestclassId - legacy id of the classdomain - domain of the classconnectionContext - DOCUMENT ME!RemoteException - if any remote error occurs@Deprecated public MetaClass getClassByTableName(User user, String tableName, String domain) throws RemoteException
MetaServicegetClassByTableName in interface MetaServiceuser - DOCUMENT ME!tableName - DOCUMENT ME!domain - DOCUMENT ME!RemoteException - DOCUMENT ME!public MetaClass getClassByTableName(User user, String tableName, String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
Gets a meta class by its name for the user form the specified domain. The REST meta class id is constructed as
tableName.domain
http://localhost:8890/classes/SWITCHON.taggetClassByTableName in interface MetaServiceuser - user performing the requesttableName - name of the classdomain - domain of the classconnectionContext - DOCUMENT ME!RemoteException - if any remote error occurs@Deprecated public MetaClass[] getClasses(User user, String domain) throws RemoteException
MetaServicegetClasses in interface MetaServiceuser - DOCUMENT ME!domain - DOCUMENT ME!RemoteException - DOCUMENT ME!public MetaClass[] getClasses(User user, String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
Gets all meta classes for the user from the specified the domain.
Example REST Call:http://localhost:8890/classes?domain=SWITCHON
getClasses in interface MetaServiceuser - legacy cids user performing the requestdomain - domain (~localserver)connectionContext - DOCUMENT ME!RemoteException - if any server error occurs@Deprecated public boolean changePassword(User user, String oldPassword, String newPassword) throws RemoteException, UserException, PasswordCheckException
UserServicechangePassword in interface UserServiceuser - DOCUMENT ME!oldPassword - DOCUMENT ME!newPassword - DOCUMENT ME!RemoteException - DOCUMENT ME!UserException - DOCUMENT ME!PasswordCheckException - DOCUMENT ME!public MethodMap getMethods(User user, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is not supported anymore in the cids REST API, it returns an empty result!
getMethods in interface MetaServiceuser - parameter is ignoredconnectionContext - DOCUMENT ME!RemoteException - never thrown@Deprecated public MethodMap getMethods(User user, String localServerName) throws RemoteException
MetaServicegetMethods in interface MetaServiceuser - DOCUMENT ME!localServerName - DOCUMENT ME!RemoteException - DOCUMENT ME!public MethodMap getMethods(User user, String localServerName, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is not supported anymore in the cids REST API, it returns an empty result!
getMethods in interface MetaServiceuser - parameter is ignoredlocalServerName - parameter is ignoredconnectionContext - DOCUMENT ME!RemoteException - never thrown@Deprecated public String[] getDomains() throws RemoteException
MetaServicegetDomains in interface MetaServiceRemoteException - DOCUMENT ME!public String[] getDomains(de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is currently not implemented in the cids REST API, it throws an Unsupported Operation Exception!
getDomains in interface MetaServiceconnectionContext - DOCUMENT ME!RemoteException - if any remote error occursUnsupportedOperationException - always thrown@Deprecated public Image[] getDefaultIcons(String domain) throws RemoteException
SystemServicegetDefaultIcons in interface SystemServicedomain - domainRemoteException - server errorpublic Image[] getDefaultIcons(String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is currently not implemented in the cids REST API, it throws an Unsupported Operation Exception!
getDefaultIcons in interface SystemServicedomain - name of the domainconnectionContext - DOCUMENT ME!RemoteException - if any remote error occursUnsupportedOperationException - DOCUMENT ME!@Deprecated public Image[] getDefaultIcons() throws RemoteException
SystemServicegetDefaultIcons in interface SystemServiceRemoteException - server error (eg no domain server online)public Image[] getDefaultIcons(de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is currently not implemented in the cids REST API, it throws an Unsupported Operation Exception!
getDefaultIcons in interface SystemServiceconnectionContext - DOCUMENT ME!RemoteException - if any remote error occursUnsupportedOperationException - DOCUMENT ME!@Deprecated public HistoryObject[] getHistory(int classId, int objectId, String domain, User user, int elements) throws RemoteException
MetaServicegetHistory in interface MetaServiceclassId - DOCUMENT ME!objectId - DOCUMENT ME!domain - DOCUMENT ME!user - DOCUMENT ME!elements - DOCUMENT ME!RemoteException - DOCUMENT ME!public HistoryObject[] getHistory(int classId, int objectId, String domain, User user, int elements, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
This operation is currently not implemented in the cids REST API, it throws an Unsupported Operation Exception!
getHistory in interface MetaServiceclassId - TODOobjectId - TODOdomain - TODOuser - TODOelements - TODOconnectionContext - DOCUMENT ME!RemoteException - TODOUnsupportedOperationException - DOCUMENT ME!public boolean changePassword(User user, String oldPassword, String newPassword, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException, UserException, PasswordCheckException
This operation is currently not implemented in the cids REST API, it throws an Unsupported Operation Exception!
changePassword in interface UserServiceuser - TODOoldPassword - TODOnewPassword - TODOconnectionContext - DOCUMENT ME!RemoteException - TODOUserException - TODOPasswordCheckException - DOCUMENT ME!UnsupportedOperationException - DOCUMENT ME!@Deprecated public User getUser(String userGroupLsName, String userGroupName, String userLsName, String userName, String password) throws RemoteException, UserException
UserServicegetUser in interface UserServiceuserGroupLsName - DOCUMENT ME!userGroupName - DOCUMENT ME!userLsName - DOCUMENT ME!userName - DOCUMENT ME!password - DOCUMENT ME!RemoteException - DOCUMENT ME!UserException - DOCUMENT ME!public User getUser(String userGroupLsName, String userGroupName, String userLsName, String userName, String password, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException, UserException
getUser in interface UserServiceuserGroupLsName - not supported by REST APIuserGroupName - not supported by REST APIuserLsName - user domainuserName - user namepassword - password of the usersconnectionContext - DOCUMENT ME!RemoteException - if any remote error occoursUserException - if the login fails@Deprecated public Vector getUserGroupNames() throws RemoteException
UserServicegetUserGroupNames in interface UserServiceRemoteException - DOCUMENT ME!public Vector getUserGroupNames(de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
getUserGroupNames in interface UserServiceconnectionContext - DOCUMENT ME!RemoteException - TODOUnsupportedOperationException - DOCUMENT ME!@Deprecated public Vector getUserGroupNames(String userName, String lsHome) throws RemoteException
UserServicegetUserGroupNames in interface UserServiceuserName - DOCUMENT ME!lsHome - DOCUMENT ME!RemoteException - DOCUMENT ME!public Vector getUserGroupNames(String userName, String lsHome, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
getUserGroupNames in interface UserServiceuserName - TODOlsHome - TODOconnectionContext - DOCUMENT ME!RemoteException - TODOUnsupportedOperationException - DOCUMENT ME!@Deprecated public String getConfigAttr(User user, String key) throws RemoteException
UserServicegetConfigAttr in interface UserServiceuser - DOCUMENT ME!key - DOCUMENT ME!RemoteException - DOCUMENT ME!public Key getPublicJwtKey(String domain) throws RemoteException
UserServicegetPublicJwtKey in interface UserServicedomain - DOCUMENT ME!RemoteException - DOCUMENT ME!public String getConfigAttr(User user, String key, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
UserServiceUser. That means if a user requests a value for a key
the value is delivered with the following strategy:
User if it is setUser's UserGroup if it is setUserGroup's Domain if it is set.null otherwise.UserGroup though the User's value
is set hand over an User object with id < 0.Domain though any other value is set hand over
an User object with id < 0 that contains a UserGroup object with id
< 0.getConfigAttr in interface UserServiceuser - the User whose value shall be retrievedkey - the key for the value to be retrievedconnectionContext - DOCUMENT ME!nullRemoteException - if an internal error occurs@Deprecated public boolean hasConfigAttr(User user, String key) throws RemoteException
UserServicehasConfigAttr in interface UserServiceuser - DOCUMENT ME!key - DOCUMENT ME!RemoteException - DOCUMENT ME!public boolean hasConfigAttr(User user, String key, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
hasConfigAttr in interface UserServiceuser - TODOkey - TODOconnectionContext - DOCUMENT ME!RemoteException - TODOUnsupportedOperationException - DOCUMENT ME!UserService.getConfigAttr(Sirius.server.newuser.User, java.lang.String)@Deprecated public Object executeTask(User user, String taskname, String domain, Object body, ServerActionParameter... params) throws RemoteException
ActionServiceexecuteTask in interface ActionServiceuser - DOCUMENT ME!taskname - DOCUMENT ME!domain - DOCUMENT ME!body - jasong DOCUMENT ME!params - DOCUMENT ME!RemoteException - DOCUMENT ME!public Object executeTask(User user, String taskname, String domain, Object body, de.cismet.connectioncontext.ConnectionContext connectionContext, ServerActionParameter... params) throws RemoteException
curl --user admin@SWITCHON:cismet
-F "taskparams"="{""actionKey"": ""downloadFile"",""description"": ""Download a remote file""
};type=application/json"
-F "file"="filetodownload;text/plain"
http://localhost:8890/actions/SWITCHON.downloadFile/tasks?role=all^&resultingInstanceType=resultexecuteTask in interface ActionServiceuser - user performing the requesttaskname - name of the task to be performeddomain - domain of the server / taskbody - body parameter of the task, e.g. byte[]connectionContext - DOCUMENT ME!params - 0...n action parametersRemoteException - if the task execution fails@Deprecated public Node[] getRoots(User user, String domainName) throws RemoteException
CatalogueServicegetRoots in interface CatalogueServiceuser - DOCUMENT ME!domainName - DOCUMENT ME!RemoteException - DOCUMENT ME!@Deprecated public Collection customServerSearch(User user, CidsServerSearch serverSearch) throws RemoteException
SearchServicecustomServerSearch in interface SearchServiceuser - DOCUMENT ME!serverSearch - DOCUMENT ME!RemoteException - DOCUMENT ME!public Collection customServerSearch(User user, CidsServerSearch serverSearch, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
RestApiCidsServerSearch interface, the
ServerSearchFactory tries to automatically generate a SearchInfo object hat is required by the
REST Search API.curl --user username@SWITCHON:password -H "Content-Type: application/json" -X POST -d
"{""list"":[{""key"":""Query"",""value"":""keyword:\\""soil\\"" limit:\\""5\\"""" }]}"
http://localhost:8890/searches/SWITCHON.de.cismet.cids.custom.switchon.search.server.MetaObjectUniversalSearchStatement/results
customServerSearch in interface SearchServiceuser - The user performing the requestserverSearch - The CidsServerSearch instanceconnectionContext - DOCUMENT ME!RemoteException - if any remote error occurspublic MetaObject[] getMetaObject(User user, String query) throws RemoteException
MetaServicegetMetaObject in interface MetaServiceuser - user tokenquery - sql queryRemoteException - server errorpublic MetaObject[] getMetaObject(User user, String query, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
getMetaObject in interface MetaServiceuser - user performing the requestquery - SQL query to select meta objectsconnectionContext - DOCUMENT ME!RemoteException - if any remote error occursgetMetaObject(Sirius.server.newuser.User, java.lang.String, java.lang.String)@Deprecated public MetaObject[] getMetaObject(User user, String query, String domain) throws RemoteException
MetaServicegetMetaObject in interface MetaServiceuser - DOCUMENT ME!query - DOCUMENT ME!domain - DOCUMENT ME!RemoteException - DOCUMENT ME!public MetaObject[] getMetaObject(User user, String query, String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
MetaObjectsByQuerySearch
and thus deprecated.getMetaObject in interface MetaServiceuser - user performing the requestquery - SQL query that returns classId and objectIddomain - DOCUMENT ME!connectionContext - DOCUMENT ME!RemoteException - if any remote error occurs@Deprecated public MetaObject getMetaObject(User user, int objectId, int classId, String domain) throws RemoteException
http://localhost:8890/SWITCHON.CONTACT/76getMetaObject in interface MetaServiceuser - user tokenobjectId - symbolic pointer to the meta objectclassId - class of the meta objectdomain - domain where the meta object is hostedRemoteException - DOCUMENT ME!public MetaObject getMetaObject(User user, int objectId, int classId, String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
MetaServicegetMetaObject in interface MetaServiceuser - DOCUMENT ME!objectId - DOCUMENT ME!classId - DOCUMENT ME!domain - DOCUMENT ME!connectionContext - DOCUMENT ME!RemoteException - DOCUMENT ME!@Deprecated public MetaObject insertMetaObject(User user, MetaObject metaObject, String domain) throws RemoteException
MetaServiceinsertMetaObject in interface MetaServiceuser - DOCUMENT ME!metaObject - DOCUMENT ME!domain - DOCUMENT ME!RemoteException - DOCUMENT ME!public MetaObject insertMetaObject(User user, MetaObject metaObject, String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
curl --user username@SWITCHON:password -H "Content-Type: application/json" -X POST -d
"{$self:'/SWITCHON.contact/31337' }" http://localhost:8890/SWITCHON.contactinsertMetaObject in interface MetaServiceuser - user tokenmetaObject - the new meta object to be createddomain - domain of the meta objectconnectionContext - DOCUMENT ME!RemoteException - if any remote error occurs@Deprecated public int updateMetaObject(User user, MetaObject metaObject, String domain) throws RemoteException
MetaServiceupdateMetaObject in interface MetaServiceuser - DOCUMENT ME!metaObject - DOCUMENT ME!domain - DOCUMENT ME!RemoteException - DOCUMENT ME!public int updateMetaObject(User user, MetaObject metaObject, String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
curl --user username@SWITCHON:password -H "Content-Type: application/json" -X PUT -d
"{$self:'/SWITCHON.contact/31337' }" http://localhost:8890/SWITCHON.contact/31337updateMetaObject in interface MetaServiceuser - user tokenmetaObject - the meta object to be updateddomain - domain of the meta objectconnectionContext - DOCUMENT ME!RemoteException - RemoteException if any remote error occurs@Deprecated public int deleteMetaObject(User user, MetaObject metaObject, String domain) throws RemoteException
MetaServicedeleteMetaObject in interface MetaServiceuser - DOCUMENT ME!metaObject - DOCUMENT ME!domain - DOCUMENT ME!RemoteException - DOCUMENT ME!public int deleteMetaObject(User user, MetaObject metaObject, String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
curl --user username@SWITCHON:password -X DELETE http://localhost:8890/switchon.contact/31337deleteMetaObject in interface MetaServiceuser - user tokenmetaObject - the meta object to be deleteddomain - the domain of the meta objectconnectionContext - DOCUMENT ME!RemoteException - if any remote error occurs@Deprecated public LightweightMetaObject[] getAllLightweightMetaObjectsForClass(int classId, User user, String[] representationFields, String representationPattern) throws RemoteException
MetaServicegetAllLightweightMetaObjectsForClass in interface MetaServiceclassId - DOCUMENT ME!user - DOCUMENT ME!representationFields - DOCUMENT ME!representationPattern - DOCUMENT ME!RemoteException - DOCUMENT ME!public LightweightMetaObject[] getAllLightweightMetaObjectsForClass(int classId, User user, String[] representationFields, String representationPattern, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
LightweightMetaObject.toString() of the LightweightMetaObject is built from the
representationFields and formatted according to the Formatter representationPattern (e.g. "%1$2s").http://localhost:8890/SWITCHON.CONTACT?level=1&fields=name,emailgetAllLightweightMetaObjectsForClass in interface MetaServiceclassId - legacy class id of the LightweightMetaObjectsuser - user tokenrepresentationFields - fields of the LightweightMetaObjectrepresentationPattern - the format pattern FormatterconnectionContext - DOCUMENT ME!RemoteException - if any remote error occurs@Deprecated public LightweightMetaObject[] getAllLightweightMetaObjectsForClass(int classId, User user, String[] representationFields) throws RemoteException
MetaServicegetAllLightweightMetaObjectsForClass in interface MetaServiceclassId - DOCUMENT ME!user - DOCUMENT ME!representationFields - DOCUMENT ME!RemoteException - DOCUMENT ME!public LightweightMetaObject[] getAllLightweightMetaObjectsForClass(int classId, User user, String[] representationFields, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
getAllLightweightMetaObjectsForClass in interface MetaServiceclassId - legacy class id of the LightweightMetaObjectsuser - user tokenrepresentationFields - files of the LightweightMetaObjectconnectionContext - DOCUMENT ME!RemoteException - if any remote error occursgetAllLightweightMetaObjectsForClass(int, Sirius.server.newuser.User, java.lang.String[],
java.lang.String)@Deprecated public LightweightMetaObject[] getLightweightMetaObjectsByQuery(int classId, User user, String query, String[] representationFields, String representationPattern) throws RemoteException
MetaServicegetLightweightMetaObjectsByQuery in interface MetaServiceclassId - DOCUMENT ME!user - DOCUMENT ME!query - DOCUMENT ME!representationFields - DOCUMENT ME!representationPattern - DOCUMENT ME!RemoteException - DOCUMENT ME!public LightweightMetaObject[] getLightweightMetaObjectsByQuery(int classId, User user, String query, String[] representationFields, String representationPattern, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
customServerSearch(Sirius.server.newuser.User, de.cismet.cids.server.search.CidsServerSearch) operation
and implemented by LightweightMetaObjectsByQuerySearchgetLightweightMetaObjectsByQuery in interface MetaServiceclassId - class id of LWMOsuser - user performing the requestquery - query to search for LWMO. Has to select at lest the primary key (ID) of the
Meta ObjectrepresentationFields - must match fields in queryrepresentationPattern - string format pattern for toStrin OperationconnectionContext - DOCUMENT ME!RemoteException - if any error occurspublic LightweightMetaObject[] getLightweightMetaObjectsByQuery(int classId, User user, String query, String[] representationFields) throws RemoteException
MetaServicegetLightweightMetaObjectsByQuery in interface MetaServiceclassId - DOCUMENT ME!user - DOCUMENT ME!query - DOCUMENT ME!representationFields - DOCUMENT ME!RemoteException - DOCUMENT ME!public LightweightMetaObject[] getLightweightMetaObjectsByQuery(int classId, User user, String query, String[] representationFields, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
customServerSearch(Sirius.server.newuser.User, de.cismet.cids.server.search.CidsServerSearch) operation
and implemented by LightweightMetaObjectsByQuerySearchgetLightweightMetaObjectsByQuery in interface MetaServiceclassId - class id of LWMOsuser - user performing the requestquery - query to search for LWMO. Has to select at lest the primary key (ID) of the
Meta ObjectrepresentationFields - must match fields in queryconnectionContext - DOCUMENT ME!RemoteException - if any error occurs@Deprecated public MetaObject getInstance(User user, MetaClass metaClass) throws RemoteException
MetaServicegetInstance in interface MetaServiceuser - DOCUMENT ME!metaClass - DOCUMENT ME!RemoteException - DOCUMENT ME!public MetaObject getInstance(User user, MetaClass metaClass, de.cismet.connectioncontext.ConnectionContext connectionContext) throws RemoteException
http://localhost:8890/SWITCHON.RESOURCE/emptyInstancegetInstance in interface MetaServiceuser - user performing the requestmetaClass - class of the new objectconnectionContext - DOCUMENT ME!RemoteException - if any remote error occursCopyright © 2012–2026 cismet GmbH. All rights reserved.