Package com.microstrategy.webapi.restApi

Class IServerRestClientBuilder

java.lang.Object

com.microstrategy.webapi.restApi.RestClientBuilder

com.microstrategy.webapi.restApi.IServerRestClientBuilder

Direct Known Subclasses:

IServerRestClientCluster

public class IServerRestClientBuilder
extends RestClientBuilder

Builder pattern to build I-Server REST Client

Ex. Sample Code

GET API call

  RestClient restClient = new IServerRestClientBuilder()
                     .sessionId(iServerSession.getSessionID())
                     .relativeUrl("/messages/B19DEDCC11D4E0EFC000EB9495D0F44F/bookmarks")
                     .methodTypes(MethodTypes.GET)
                     .build();

POST API call

 RestClient restClient = new IServerRestClientBuilder()
                      .sessionId(iServerSession.getSessionID())
                     .relativeUrl("/messages/B19DEDCC11D4E0EFC000EB9495D0F44F/bookmarks")
                     .mediaType(MediaTypes.APPLICATION_JSON)
                     .body("{}")

                     .methodTypes(MethodTypes.POST)
                     .build();
 

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	I_SERVER_PROJECT_ID_HEADER
protected static java.lang.String	I_SERVER_SESSION_HEADER
protected java.lang.String	relativeUrl
protected java.lang.String	sessionId

Fields inherited from class com.microstrategy.webapi.restApi.RestClientBuilder

body, connectTimeout, headers, isTLSEnabled, mediaType, methodTypes, readTimeout, responseWrapper, url

Constructor Summary

Constructors

Constructor	Description
IServerRestClientBuilder()

Method Summary

Modifier and Type	Method	Description
IServerRestClientBuilder	addheader(java.lang.String key, java.lang.String value)	adds individual header key-value
IServerRestClientBuilder	body(java.lang.String body)	String as request body.
RestClient	build()
IServerRestClientBuilder	connectTimeout(int connectTimeout)	Set http connect timeout
IServerRestClientBuilder	headers(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)
IServerRestClientBuilder	mediaType(MediaTypes mediaType)	Set media type using Enum
IServerRestClientBuilder	mediaType(java.lang.String mediaType)	Set media type using String value
IServerRestClientBuilder	methodTypes(MethodTypes methodTypes)
IServerRestClientBuilder	readTimeout(int readTimeout)	Set http read timeout
IServerRestClientBuilder	relativeUrl(java.lang.String relativeUrl)	Provide a relative URL
IServerRestClientBuilder	sessionId(java.lang.String sessionId)	Set the session ID
IServerRestClientBuilder	streamBody(java.io.InputStream inputStream)	Input stream as request body.
java.lang.String	toString()
IServerRestClientBuilder	url(java.lang.String url)

Methods inherited from class com.microstrategy.webapi.restApi.RestClientBuilder

responseWrapper

Methods inherited from class java.lang.Object

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

Field Detail

I_SERVER_SESSION_HEADER

protected static final java.lang.String I_SERVER_SESSION_HEADER

See Also:

Constant Field Values

I_SERVER_PROJECT_ID_HEADER

protected static final java.lang.String I_SERVER_PROJECT_ID_HEADER

See Also:

Constant Field Values

sessionId

protected java.lang.String sessionId

relativeUrl

protected java.lang.String relativeUrl

Constructor Detail

IServerRestClientBuilder

public IServerRestClientBuilder()

Method Detail

sessionId

public IServerRestClientBuilder sessionId(java.lang.String sessionId)

Set the session ID

Parameters:

sessionId -

relativeUrl

public IServerRestClientBuilder relativeUrl(java.lang.String relativeUrl)

Provide a relative URL

Parameters:

relativeUrl -

url

public IServerRestClientBuilder url(java.lang.String url)

Overrides:

url in class RestClientBuilder

Returns:

body

public IServerRestClientBuilder body(java.lang.String body)

Description copied from class: RestClientBuilder

String as request body.

Overrides:

body in class RestClientBuilder

Parameters:

body - string

Returns:

builder

streamBody

public IServerRestClientBuilder streamBody(java.io.InputStream inputStream)

Description copied from class: RestClientBuilder

Input stream as request body.

Overrides:

streamBody in class RestClientBuilder

Parameters:

inputStream - input stream

Returns:

builder

methodTypes

public IServerRestClientBuilder methodTypes(MethodTypes methodTypes)

Overrides:

methodTypes in class RestClientBuilder

Returns:

headers

public IServerRestClientBuilder headers(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Overrides:

headers in class RestClientBuilder

Returns:

addheader

public IServerRestClientBuilder addheader(java.lang.String key,
                                          java.lang.String value)

Description copied from class: RestClientBuilder

adds individual header key-value

Overrides:

addheader in class RestClientBuilder

Returns:

mediaType

public IServerRestClientBuilder mediaType(java.lang.String mediaType)

Description copied from class: RestClientBuilder

Set media type using String value

Overrides:

mediaType in class RestClientBuilder

Parameters:

mediaType - Any valid "accept" header value

Returns:

mediaType

public IServerRestClientBuilder mediaType(MediaTypes mediaType)

Description copied from class: RestClientBuilder

Set media type using Enum

Overrides:

mediaType in class RestClientBuilder

Returns:

connectTimeout

public IServerRestClientBuilder connectTimeout(int connectTimeout)

Set http connect timeout

Overrides:

connectTimeout in class RestClientBuilder

Parameters:

connectTimeout -

Returns:

readTimeout

public IServerRestClientBuilder readTimeout(int readTimeout)

Set http read timeout

Overrides:

readTimeout in class RestClientBuilder

Parameters:

readTimeout -

Returns:

build

public RestClient build()
                 throws MSTRWebAPIException

Overrides:

build in class RestClientBuilder

Returns:

Throws:

MSTRWebAPIException

toString

public java.lang.String toString()

Overrides:

toString in class RestClientBuilder