Ontimize Web Services 1.003EN
B C D E G H I L O P Q R T U V W

B

belongToARemoteInterface(String, Class<?>, Class[]) - Static method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
Checks if the remote method belongs to a remote interface.

C

com.ontimize.webservice.prebuiltClient - package com.ontimize.webservice.prebuiltClient
 
com.ontimize.webservice.server - package com.ontimize.webservice.server
 
configurationFilePath - Variable in class com.ontimize.webservice.prebuiltClient.OWSClient
 
connect() - Method in class com.ontimize.webservice.prebuiltClient.OWSClient
Connecting to the Ontimize Web Service indicated by the OntimizeWebServiceClient.properties file and calling the init session method in order to connect with the server and obtain the sessionId.
createEmptyWrongEntityResult() - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
Creates a new entity result and set its code to indicated that the operation has been wrong.

D

DEBUG - Static variable in class com.ontimize.webservice.prebuiltClient.OWSClient
 
DEBUG - Static variable in class com.ontimize.webservice.server.OntimizeWebServiceImpl
 
delete(Hashtable, String) - Method in class com.ontimize.webservice.prebuiltClient.OWSClient
 
delete(List<OWSDoubleData>, int, String, String) - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
This method performs the standard Ontimize delete.

E

endSession(int, int) - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
method that ends the Ontimize session for the indicated sessionId.
entityResult2WSFormat(EntityResult) - Static method in class com.ontimize.webservice.server.WSUtils
Convert a Ontimize EntityResult to an object, which is defined in web services format.
execute(String, String, Vector, int, String, String) - Method in class com.ontimize.webservice.prebuiltClient.OWSClient
 
execute(String, String, List<OWSComplexData>, int, String, String) - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
This method has been developed to allow programmers to execute whatever method (apart from the standard query, insert, update and delete).

G

getObject(String, int, String) - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
Get the unique rmi object indicated by the parameters host-port-name.
getPropertiesFile() - Method in class com.ontimize.webservice.prebuiltClient.OWSClient
This method get the client configuration properties file named OntimizeWebServiceClient.properties.
getPropertiesFile() - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
This method get the client configuration properties file named webservice.properties.

H

hashtable2WSFormat(Hashtable<Object, Object>) - Static method in class com.ontimize.webservice.server.WSUtils
Convert a java Hashtable to an object, which is defined in web services format.

I

initSession(String, String, int) - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
This method performs the init session of the client through the web service.
insert(Hashtable, String) - Method in class com.ontimize.webservice.prebuiltClient.OWSClient
 
insert(List<OWSDoubleData>, int, String, String) - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
This method performs the standard Ontimize insert.
interfaceExtendsInterface(Class, String) - Static method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
Checks if the indicated interface class extends interfaceName.
isARemoteMethod(Method, String, Class<?>, Class[]) - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
Return true if the indicated methods is a remote method and which also belong to a remote (or extended remote) interface.
isBoolean(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isByte(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isByteArray(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isCharacter(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isDate(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isDouble(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isFloat(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isInteger(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isLong(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isShort(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isString(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isTime(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isTimestamp(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
isURL(String) - Static method in class com.ontimize.webservice.server.WSUtils
 

L

listOWSComplexData2Hashtable(List<OWSComplexData>) - Static method in class com.ontimize.webservice.server.WSUtils
Convert an Object codified in the web service format into a normal java Vector.
listOWSDoubleData2Hashtable(List<OWSDoubleData>) - Static method in class com.ontimize.webservice.server.WSUtils
Convert an Object codified in the web service format into a normal java Hashtable.
locator - Variable in class com.ontimize.webservice.server.OntimizeWebServiceImpl
 

O

OntimizeWebServiceImpl - Class in com.ontimize.webservice.server
Implements the operations that can be performed in an Ontimize Web Service, such as, standard initSession, query, insert, update and delete, and also a generic method (called execute) which allow developers to run whatever remote method.
OntimizeWebServiceImpl() - Constructor for class com.ontimize.webservice.server.OntimizeWebServiceImpl
 
OWSClient - Class in com.ontimize.webservice.prebuiltClient
Java client methods which can be used in an Ontimize enviroment to develop a Ontimize Web Service application.
OWSClient() - Constructor for class com.ontimize.webservice.prebuiltClient.OWSClient
 
OWSClient(String) - Constructor for class com.ontimize.webservice.prebuiltClient.OWSClient
 
owsEntityResult2EntityResult(OWSEntityResult) - Static method in class com.ontimize.webservice.server.WSUtils
Convert an Object codified in the web service format into a normal Ontimize EntityResult.

P

printEntityResultInformation(EntityResult, String) - Static method in class com.ontimize.webservice.prebuiltClient.OWSClient
Class to print the entity result content that the operations return
printErrorParsingInformation(String, String) - Static method in class com.ontimize.webservice.server.WSUtils
Print always in the system error console the information related to the permitted data types for the Ontimize Web Services.

Q

query(Hashtable, Vector, String) - Method in class com.ontimize.webservice.prebuiltClient.OWSClient
This method must implement a standard query operation returning the set of data that matches the conditions specified by the keysValues parameter.
query(List<OWSDoubleData>, List<OWSComplexData>, int, String, String) - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
This method performs the standard Ontimize query.

R

readProperties() - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
Read the configuration properties file called webservice.properties to fill the neccesary parameters to be able to init session.
readPropertiesFile(Properties) - Method in class com.ontimize.webservice.prebuiltClient.OWSClient
read the userLogin, userPâssword and urlConnection properties sent in the properties variable which was the result of popullate the variable with the client configuration file.
remoteLocatorRegistryName - Variable in class com.ontimize.webservice.server.OntimizeWebServiceImpl
 

T

throwsRemoteExceptions(Method) - Static method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
Checks if the method throw (remote) exceptions.

U

update(Hashtable, Hashtable, String) - Method in class com.ontimize.webservice.prebuiltClient.OWSClient
 
update(List<OWSDoubleData>, List<OWSDoubleData>, int, String, String) - Method in class com.ontimize.webservice.server.OntimizeWebServiceImpl
This method performs the standard Ontimize update.

V

value2Boolean(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2Byte(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2ByteArray(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2Character(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2Date(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2Double(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2Float(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2Integer(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2Long(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2ObjectDependsOnType(String, String) - Static method in class com.ontimize.webservice.server.WSUtils
Evaluates the class indicated by the string "type", and depending on it, generates a new Object to return of that class
value2Short(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2String(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2Time(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2Timestamp(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
value2URL(String) - Static method in class com.ontimize.webservice.server.WSUtils
 
values2Class(Vector<Object>) - Static method in class com.ontimize.webservice.server.WSUtils
Converts a vector in an Class Array.
vector2ObjectArray(Vector<Object>) - Static method in class com.ontimize.webservice.server.WSUtils
Convert a vector into an Object Array.
vector2WSFormat(Vector<Object>) - Static method in class com.ontimize.webservice.server.WSUtils
Convert a java Vector to an object, which is defined in web services format.

W

webServicehost - Variable in class com.ontimize.webservice.server.OntimizeWebServiceImpl
 
webServicePort - Variable in class com.ontimize.webservice.server.OntimizeWebServiceImpl
 
WSUtils - Class in com.ontimize.webservice.server
This class contains several utils to convert data from Ontimize format to specific web services format for that application, and viceversa.
WSUtils() - Constructor for class com.ontimize.webservice.server.WSUtils
 

B C D E G H I L O P Q R T U V W
Ontimize Web Services