com.ibm.maximo.oslc

Class MaximoConnector

java.lang.Object

com.ibm.maximo.oslc.MaximoConnector

public class MaximoConnector
extends Object

MaximoConnector is a Connector between Oslc Client and Maximo Server. It provides the authentication setting, connect, basic requests and disconnect for Server.

This object can be created by MaximoConnector with Options. The following code shows how to initial MaximoConnector using MaximoConnector and OptionsConstructor

 
 MaximoConnector mc = new MaximoConnector(new Options().user(userName)
 .password(password).mt(true).lean(false).auth(authMethod)
 .host(hostAddress).port(portNum));
 
 

The following examples demonstrate how to build a new MaximoConnector

 
 Options op = new Options();
 MaximoConnector mc = new MaximoConnector();
 mc.options(op);
 MaximoConnector mc = new MaximoConnector(Options);
 
 

The following examples demonstrate how to set authentication, method, cookie for session to MaximoConnector

 
 mc.setAuth(authMethod);
 mc.setMethod(httpConnection,method);
 mc.setCookieForSession(httpConnection);
 
 

The following examples show how to connect, get, create, update, merge, delete and disconnect to Maximo Server by MaximoConnector. The properties can be empty

 
 mc.connect();
 JsonObject jo = mc.get(uri);
 byte[] docBytes = mc.getAttachmentData(uri);
 byte[] docBytes = mc.attachedDoc(uri);
 JsonObject jp = mc.getAttachmentMeta(uri);
 JsonObject jo = mc.create(uri, jsonObject, properties);
 JsonObject jo = mc.createAttachment(uri, data, name, decription, meta);
 JsonObject jo = mc.update(uri, jsonObject, properties);
 JsonObject jo = mc.merge(uri, jsonObject, properties);
 mc.delete(uri);
 mc.deleteResource(uri);
 mc.deleteAttachment(uri);
 mc.disconnect();
 
 

The following examples show how to get ResourceSet or Resource or Attachment by MaximoConnector

 ResourceSet rs = mc.resourceSet(osName);
 ResourceSet rs = mc.resourceSet(url);
 Resource re = mc.resource(uri);
 Attachment att = mc.attachment(uri);
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_METHOD_BULK
static String	HTTP_METHOD_DELETE
static String	HTTP_METHOD_GET
static String	HTTP_METHOD_MERGE
static String	HTTP_METHOD_MERGESYNC
static String	HTTP_METHOD_PATCH
static String	HTTP_METHOD_POST
static String	HTTP_METHOD_SYNC
String	httpMethod
static Logger	logger

Constructor Summary

Constructors

Constructor and Description
MaximoConnector()
MaximoConnector(Options options)

Method Summary

Methods

Modifier and Type	Method and Description
Attachment	attachment(String uri, String... properties)
javax.json.JsonObject	attachmentDocMeta(String uri)
javax.json.JsonArray	bulk(String uri, javax.json.JsonArray ja)
javax.json.JsonArray	bulk(String uri, javax.json.JsonArray ja, Map<String,Object> headers)
void	connect() Connect to Maximo Server
void	connect(Proxy proxy) Connect to Maximo Server with Proxy
javax.json.JsonObject	create(String uri, javax.json.JsonObject jo, Map<String,Object> headers, String... properties)
javax.json.JsonObject	create(String uri, javax.json.JsonObject jo, String... properties) Create new Resource
javax.json.JsonObject	createAttachment(String uri, byte[] data, String name, String description, String meta) Create new attachment
javax.json.JsonObject	createAttachment(String uri, byte[] data, String name, String description, String meta, Map<String,Object> headers)
MaximoConnector	debug(boolean isDebug)
void	delete(String uri) Delete the resource/attachment
void	delete(String uri, Map<String,Object> headers)
void	deleteAttachment(String uri)
void	deleteResource(String uri)
void	disconnect() Disconnect with Maximo Server
static String	encode(String userName, String password)
javax.json.JsonObject	get(String uri)
javax.json.JsonObject	get(String uri, Map<String,Object> headers)
byte[]	getAttachmentData(String uri) Load DocumentData
byte[]	getAttachmentData(String uri, Map<String,Object> headers)
String	getCurrentURI()
int	getLastResponseCode() Get the last response code
Options	getOptions()
javax.json.JsonArray	groupBy(String uri) Fetch Group By data
javax.json.JsonArray	groupBy(String uri, Map<String,Object> headers)
boolean	isDebug()
boolean	isLean()
boolean	isValid()
javax.json.JsonObject	merge(String uri, javax.json.JsonObject jo, Map<String,Object> headers, String... properties)
javax.json.JsonObject	merge(String uri, javax.json.JsonObject jo, String... properties)
javax.json.JsonObject	mergeSync(String uri, javax.json.JsonObject jo, Map<String,Object> headers, String... properties)
javax.json.JsonObject	mergeSync(String uri, javax.json.JsonObject jo, String... properties)
MaximoConnector	options(Options op)
Resource	resource(String uri, String... properties)
ResourceSet	resourceSet()
ResourceSet	resourceSet(String osName)
ResourceSet	resourceSet(URL url)
protected HttpURLConnection	setAuth(String uri)
protected HttpURLConnection	setAuth(String uri, Proxy proxy)
protected HttpURLConnection	setHeaders(HttpURLConnection con, Map<String,Object> headers)
protected HttpURLConnection	setMethod(HttpURLConnection con, String method, String... properties)
javax.json.JsonObject	sync(String uri, javax.json.JsonObject jo, Map<String,Object> headers, String... properties)
javax.json.JsonObject	sync(String uri, javax.json.JsonObject jo, String... properties)
javax.json.JsonObject	update(String uri, javax.json.JsonObject jo, Map<String,Object> headers, String... properties)
javax.json.JsonObject	update(String uri, javax.json.JsonObject jo, String... properties) Update the Resource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

public static final Logger logger

HTTP_METHOD_POST

public static final String HTTP_METHOD_POST

See Also:

Constant Field Values

HTTP_METHOD_GET

public static final String HTTP_METHOD_GET

See Also:

Constant Field Values

HTTP_METHOD_PATCH

public static final String HTTP_METHOD_PATCH

See Also:

Constant Field Values

HTTP_METHOD_MERGE

public static final String HTTP_METHOD_MERGE

See Also:

Constant Field Values

HTTP_METHOD_DELETE

public static final String HTTP_METHOD_DELETE

See Also:

Constant Field Values

HTTP_METHOD_BULK

public static final String HTTP_METHOD_BULK

See Also:

Constant Field Values

HTTP_METHOD_SYNC

public static final String HTTP_METHOD_SYNC

See Also:

Constant Field Values

HTTP_METHOD_MERGESYNC

public static final String HTTP_METHOD_MERGESYNC

See Also:

Constant Field Values

httpMethod

public String httpMethod

Constructor Detail

MaximoConnector

public MaximoConnector()

MaximoConnector

public MaximoConnector(Options options)

Method Detail

resourceSet

public ResourceSet resourceSet()

resourceSet

public ResourceSet resourceSet(String osName)

resourceSet

public ResourceSet resourceSet(URL url)
                        throws IOException,
                               OslcException

Throws:

IOException

OslcException

resource

public Resource resource(String uri,
                String... properties)
                  throws IOException,
                         OslcException

Throws:

IOException

OslcException

attachment

public Attachment attachment(String uri,
                    String... properties)
                      throws IOException,
                             OslcException

Throws:

IOException

OslcException

attachmentDocMeta

public javax.json.JsonObject attachmentDocMeta(String uri)
                                        throws IOException,
                                               OslcException

Throws:

IOException

OslcException

options

public MaximoConnector options(Options op)

getCurrentURI

public String getCurrentURI()

getOptions

public Options getOptions()

debug

public MaximoConnector debug(boolean isDebug)

isDebug

public boolean isDebug()

isValid

public boolean isValid()

isLean

public boolean isLean()

connect

public void connect()
             throws IOException,
                    OslcException

Connect to Maximo Server

Throws:

IOException

OslcException

connect

public void connect(Proxy proxy)
             throws IOException,
                    OslcException

Connect to Maximo Server with Proxy

Throws:

IOException

OslcException

get

public javax.json.JsonObject get(String uri)
                          throws IOException,
                                 OslcException

Throws:

IOException

OslcException

get

public javax.json.JsonObject get(String uri,
                        Map<String,Object> headers)
                          throws IOException,
                                 OslcException

Throws:

IOException

OslcException

groupBy

public javax.json.JsonArray groupBy(String uri)
                             throws IOException,
                                    OslcException

Fetch Group By data

Parameters:

uri -

Returns:

JsonArray

Throws:

IOException

OslcException

groupBy

public javax.json.JsonArray groupBy(String uri,
                           Map<String,Object> headers)
                             throws IOException,
                                    OslcException

Throws:

IOException

OslcException

getAttachmentData

public byte[] getAttachmentData(String uri)
                         throws IOException,
                                OslcException

Load DocumentData

Throws:

IOException

OslcException

getAttachmentData

public byte[] getAttachmentData(String uri,
                       Map<String,Object> headers)
                         throws IOException,
                                OslcException

Throws:

IOException

OslcException

create

public javax.json.JsonObject create(String uri,
                           javax.json.JsonObject jo,
                           String... properties)
                             throws IOException,
                                    OslcException

Create new Resource

Parameters:

jo -

Throws:

IOException

OslcException

create

public javax.json.JsonObject create(String uri,
                           javax.json.JsonObject jo,
                           Map<String,Object> headers,
                           String... properties)
                             throws IOException,
                                    OslcException

Throws:

IOException

OslcException

createAttachment

public javax.json.JsonObject createAttachment(String uri,
                                     byte[] data,
                                     String name,
                                     String description,
                                     String meta)
                                       throws IOException,
                                              OslcException

Create new attachment

Parameters:

data -

name -

description -

meta -

Throws:

IOException

OslcException

createAttachment

public javax.json.JsonObject createAttachment(String uri,
                                     byte[] data,
                                     String name,
                                     String description,
                                     String meta,
                                     Map<String,Object> headers)
                                       throws IOException,
                                              OslcException

Throws:

IOException

OslcException

update

public javax.json.JsonObject update(String uri,
                           javax.json.JsonObject jo,
                           String... properties)
                             throws IOException,
                                    OslcException

Update the Resource

Parameters:

jo -

Throws:

IOException

OslcException

update

public javax.json.JsonObject update(String uri,
                           javax.json.JsonObject jo,
                           Map<String,Object> headers,
                           String... properties)
                             throws IOException,
                                    OslcException

Throws:

IOException

OslcException

merge

public javax.json.JsonObject merge(String uri,
                          javax.json.JsonObject jo,
                          String... properties)
                            throws IOException,
                                   OslcException

Throws:

IOException

OslcException

merge

public javax.json.JsonObject merge(String uri,
                          javax.json.JsonObject jo,
                          Map<String,Object> headers,
                          String... properties)
                            throws IOException,
                                   OslcException

Throws:

IOException

OslcException

bulk

public javax.json.JsonArray bulk(String uri,
                        javax.json.JsonArray ja)
                          throws IOException,
                                 OslcException

Throws:

IOException

OslcException

bulk

public javax.json.JsonArray bulk(String uri,
                        javax.json.JsonArray ja,
                        Map<String,Object> headers)
                          throws IOException,
                                 OslcException

Throws:

IOException

OslcException

sync

public javax.json.JsonObject sync(String uri,
                         javax.json.JsonObject jo,
                         String... properties)
                           throws IOException,
                                  OslcException

Throws:

IOException

OslcException

sync

public javax.json.JsonObject sync(String uri,
                         javax.json.JsonObject jo,
                         Map<String,Object> headers,
                         String... properties)
                           throws IOException,
                                  OslcException

Throws:

IOException

OslcException

mergeSync

public javax.json.JsonObject mergeSync(String uri,
                              javax.json.JsonObject jo,
                              String... properties)
                                throws IOException,
                                       OslcException

Throws:

IOException

OslcException

mergeSync

public javax.json.JsonObject mergeSync(String uri,
                              javax.json.JsonObject jo,
                              Map<String,Object> headers,
                              String... properties)
                                throws IOException,
                                       OslcException

Throws:

IOException

OslcException

delete

public void delete(String uri)
            throws IOException,
                   OslcException

Delete the resource/attachment

Throws:

IOException

OslcException

delete

public void delete(String uri,
          Map<String,Object> headers)
            throws IOException,
                   OslcException

Throws:

IOException

OslcException

deleteResource

public void deleteResource(String uri)
                    throws IOException,
                           OslcException

Throws:

IOException

OslcException

deleteAttachment

public void deleteAttachment(String uri)
                      throws IOException,
                             OslcException

Throws:

IOException

OslcException

encode

public static String encode(String userName,
            String password)
                     throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

setAuth

protected HttpURLConnection setAuth(String uri)
                             throws IOException

Throws:

IOException

setAuth

protected HttpURLConnection setAuth(String uri,
                        Proxy proxy)
                             throws IOException

Throws:

IOException

setHeaders

protected HttpURLConnection setHeaders(HttpURLConnection con,
                           Map<String,Object> headers)
                                throws IOException,
                                       OslcException

Throws:

IOException

OslcException

setMethod

protected HttpURLConnection setMethod(HttpURLConnection con,
                          String method,
                          String... properties)
                               throws IOException,
                                      OslcException

Throws:

IOException

OslcException

getLastResponseCode

public int getLastResponseCode()

Get the last response code

disconnect

public void disconnect()
                throws IOException

Disconnect with Maximo Server

Throws:

IOException