Package com.microstrategy.webapi.restApi

Class IServerRestClientCluster

java.lang.Object

com.microstrategy.webapi.restApi.RestClientBuilder

com.microstrategy.webapi.restApi.IServerRestClientBuilder

com.microstrategy.webapi.restApi.IServerRestClientCluster

public class IServerRestClientCluster
extends IServerRestClientBuilder

Create a rest client to a specific Intelligence Server in the cluster

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<java.lang.String>	projectIds
protected java.util.List<ProjectRequest>	projectRequests

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

I_SERVER_PROJECT_ID_HEADER, I_SERVER_SESSION_HEADER, relativeUrl, sessionId

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

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

Constructor Summary

Constructors

Constructor	Description
IServerRestClientCluster()

Method Summary

Modifier and Type	Method	Description
IServerRestClientCluster	addheader(java.lang.String key, java.lang.String value)	REST client cluster should not use add headers to update each client instance, Instead the headers should be defined in build method as it is per client instance
IServerRestClientCluster	body(java.lang.String body)	REST client cluster should not use body to update each client instance, unless each project in request has the same request body.
RestClient	build(IDSSXMLSessionId iSessionId)
RestClient	build(IDSSXMLSessionId iSessionId, java.lang.String requestBody)
IServerRestClientCluster	connectTimeout(int connectTimeout)	Set http connect timeout
java.lang.String	getMasterSessionId()
java.util.List<java.lang.String>	getProjectIds()
java.util.List<ProjectRequest>	getProjectRequests()
IServerRestClientCluster	headers(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)	REST client cluster should not use add headers to update each client instance, Instead the headers should be defined in build method as it is per client instance
IServerRestClientCluster	mediaType(MediaTypes mediaType)	Set media type using Enum
IServerRestClientCluster	mediaType(java.lang.String mediaType)	Set media type using String value
IServerRestClientCluster	methodTypes(MethodTypes methodTypes)
IServerRestClientCluster	projectIds(java.util.List<java.lang.String> projectIds)
IServerRestClientCluster	projectRequests(java.util.List<ProjectRequest> projectRequests)
IServerRestClientCluster	readTimeout(int readTimeout)	Set http read timeout
IServerRestClientCluster	relativeUrl(java.lang.String relativeUrl)	Provide a relative URL
IServerRestClientCluster	sessionId(java.lang.String sessionId)	master session to the cluster of Intelligence Servers
IServerRestClientCluster	url(java.lang.String url)	REST client cluster should not use add headers to update each client instance, Instead the url should be defined in build method as it is per client instance

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

build, streamBody, toString

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

projectIds

protected java.util.List<java.lang.String> projectIds

projectRequests

protected java.util.List<ProjectRequest> projectRequests

Constructor Detail

IServerRestClientCluster

public IServerRestClientCluster()

Method Detail

projectIds

public IServerRestClientCluster projectIds(java.util.List<java.lang.String> projectIds)

projectRequests

public IServerRestClientCluster projectRequests(java.util.List<ProjectRequest> projectRequests)

sessionId

public IServerRestClientCluster sessionId(java.lang.String sessionId)

master session to the cluster of Intelligence Servers

Overrides:

sessionId in class IServerRestClientBuilder

Parameters:

sessionId -

Returns:

relativeUrl

public IServerRestClientCluster relativeUrl(java.lang.String relativeUrl)

Description copied from class: IServerRestClientBuilder

Provide a relative URL

Overrides:

relativeUrl in class IServerRestClientBuilder

url

public IServerRestClientCluster url(java.lang.String url)

REST client cluster should not use add headers to update each client instance, Instead the url should be defined in build method as it is per client instance

Overrides:

url in class IServerRestClientBuilder

Parameters:

url -

Returns:

body

public IServerRestClientCluster body(java.lang.String body)

REST client cluster should not use body to update each client instance, unless each project in request has the same request body. If each project in request has different request body, body should be defined in build method with requestbody as input parameter

Overrides:

body in class IServerRestClientBuilder

Parameters:

body -

Returns:

methodTypes

public IServerRestClientCluster methodTypes(MethodTypes methodTypes)

Overrides:

methodTypes in class IServerRestClientBuilder

Returns:

headers

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

REST client cluster should not use add headers to update each client instance, Instead the headers should be defined in build method as it is per client instance

Overrides:

headers in class IServerRestClientBuilder

Parameters:

headers -

Returns:

addheader

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

REST client cluster should not use add headers to update each client instance, Instead the headers should be defined in build method as it is per client instance

Overrides:

addheader in class IServerRestClientBuilder

Parameters:

key -

value -

Returns:

mediaType

public IServerRestClientCluster mediaType(java.lang.String mediaType)

Description copied from class: RestClientBuilder

Set media type using String value

Overrides:

mediaType in class IServerRestClientBuilder

Parameters:

mediaType - Any valid "accept" header value

Returns:

mediaType

public IServerRestClientCluster mediaType(MediaTypes mediaType)

Description copied from class: RestClientBuilder

Set media type using Enum

Overrides:

mediaType in class IServerRestClientBuilder

Returns:

connectTimeout

public IServerRestClientCluster connectTimeout(int connectTimeout)

Set http connect timeout

Overrides:

connectTimeout in class IServerRestClientBuilder

Parameters:

connectTimeout -

Returns:

readTimeout

public IServerRestClientCluster readTimeout(int readTimeout)

Set http read timeout

Overrides:

readTimeout in class IServerRestClientBuilder

Parameters:

readTimeout -

Returns:

getProjectIds

public java.util.List<java.lang.String> getProjectIds()

getProjectRequests

public java.util.List<ProjectRequest> getProjectRequests()

getMasterSessionId

public java.lang.String getMasterSessionId()

build

public RestClient build(IDSSXMLSessionId iSessionId)
                 throws MSTRWebAPIException

Parameters:

iSessionId - - a configuration session Id or a project session Id targeting to a specific Intelligence Server

Returns:

RestClient - a object to send the http request to the specific Intelligence Server

Throws:

MSTRWebAPIException

build

public RestClient build(IDSSXMLSessionId iSessionId,
                        java.lang.String requestBody)
                 throws MSTRWebAPIException

Parameters:

iSessionId - - a configuration session Id or a project session Id targeting to a specific Intelligence Server

requestBody - - the specific request body to the Intelligence Server

Returns:

RestClient - a object to send the http request to the specific Intelligence Server

Throws:

MSTRWebAPIException