com.esri.arcgis.system

Class ServerUtilities

java.lang.Object

com.esri.arcgis.system.ServerUtilities

public class ServerUtilities
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ServerUtilities()

Method Summary

Modifier and Type	Method and Description
static JSONObject	createOperation(java.lang.String operationName, java.lang.String parameterList, java.lang.String supportedOutputFormatsList, boolean postOnly) Creates an operation that can be called on a REST resource, using specified name, parameter list and output formats list
static JSONObject	createResource(java.lang.String name, java.lang.String description, boolean isCollection, boolean isDefaultCollection) Creates a REST resource based on specified name, description and collection flag
static Envelope	getEnvelopeFromJSON(JSONObject jobj) Retrieves Envelope from JSON
static IGeometry	getGeometryFromJSON(JSONObject geometryJSON) Returns an IGeometry given a JSON Object
static java.util.Set	getGroupInfo() Provides user group information by leveraging Sharing API This method can be directly called from the main SOI class (usage: Set roles = ServerUtilities.getGroupInfo();)
static JSONObject	getJSONFromEnvelope(Envelope env) Retrieves JSON from Envelope
static JSONObject	getJSONFromFeature(Feature feature) Returns JSON representation of a Feature object
static JSONObject	getJSONFromGeometry(IGeometry geometry) Returns JSON representation of specified geometry
static JSONObject	getJSONFromMultipoint(Multipoint multipoint) Returns JSON representation of a Multipoint object
static JSONObject	getJSONFromPoint(Point point) Returns JSON representation of a Point object
static JSONObject	getJSONFromPolygon(Polygon polygon) Returns JSON representation of a Polygon object
static JSONObject	getJSONFromPolyline(Polyline polyline) Returns JSON representation of a Polyline object
static JSONObject	getJSONFromSR(ISpatialReference sr) Retrieves JSON from Spatial Reference
static Multipoint	getMultipointFromJSON(JSONObject multipointJSON) Extracts MultiPoint geometry from specified JSONObject
static OutputStore	getOutputStore(IServerObject mapServer) Platform-agnostic way to create a client for the output store Use this method instead of the constructor for implementations of the OutputStore interface.
static Point	getPointFromJSON(JSONObject pointJSON) Extracts Point geometry from specified JSONObject
static Polygon	getPolygonFomJSON(JSONObject polygonJSON) Extracts Polygon geometry from specified JSONObject
static Polyline	getPolylineFomJSON(JSONObject polylineJSON) Extracts Polyline geometry from specified JSONObject
static ILog2	getServerLogger() Returns a handle to ArcGIS Server's log file via the ILog2 interface.
static IServerUserInfo	getServerUserInfo() Returns an IServerUserInfo, which can be used to retrieve security info such as user name and the role the user name belongs to.
static ISpatialReference	getSRFromJSON(JSONObject spatialReferenceJSON) Retrieves spatial reference from JSON
static ISpatialReference	getSRFromString(java.lang.String spatialReferenceString) Retrieves spatial reference from string This method may throw a runtime exception in case of errors
static boolean	isKubernetes() Checks environmental variables to determine whether the SOE is running in windows/linux (server) or kubernetes
static java.lang.String	sendError(int codeNumber, java.lang.String errorMessageSummary, java.lang.String[] errorMessageDetails) Sends error message back to client in proper JSON format, which is as follows * { "error": { "code": 400, "message": "Cannot perform query.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerUtilities

public ServerUtilities()

Method Detail

getOutputStore

public static OutputStore getOutputStore(IServerObject mapServer)

Platform-agnostic way to create a client for the output store Use this method instead of the constructor for implementations of the OutputStore interface.

Parameters:

mapServer -

Returns:

an output store implementation

isKubernetes

public static boolean isKubernetes()

Checks environmental variables to determine whether the SOE is running in windows/linux (server) or kubernetes

Returns:

true if running in kubernetes, false otherwise

getSRFromString

public static ISpatialReference getSRFromString(java.lang.String spatialReferenceString)
                                         throws java.lang.Exception

Retrieves spatial reference from string This method may throw a runtime exception in case of errors

Parameters:

spatialReferenceString -

Returns:

ISpatialReference

Throws:

java.lang.Exception

getSRFromJSON

public static ISpatialReference getSRFromJSON(JSONObject spatialReferenceJSON)
                                       throws java.lang.Exception

Retrieves spatial reference from JSON

Parameters:

spatialReferenceJSON -

Returns:

ISpatialReference

Throws:

java.lang.Exception

getJSONFromSR

public static JSONObject getJSONFromSR(ISpatialReference sr)

Retrieves JSON from Spatial Reference

Parameters:

sr -

Returns:

getJSONFromPoint

public static JSONObject getJSONFromPoint(Point point)
                                   throws java.lang.Exception

Returns JSON representation of a Point object

Parameters:

point - com.esri.arcgis.geometry.Point

Returns:

JSONObject JSON representation of input Point

Throws:

java.lang.Exception

getJSONFromMultipoint

public static JSONObject getJSONFromMultipoint(Multipoint multipoint)
                                        throws java.lang.Exception

Returns JSON representation of a Multipoint object

Parameters:

multipoint - com.esri.arcgis.geometry.Multipoint

Returns:

JSONObject JSON representation of input Multipoint

Throws:

java.lang.Exception

getJSONFromPolyline

public static JSONObject getJSONFromPolyline(Polyline polyline)
                                      throws java.lang.Exception

Returns JSON representation of a Polyline object

Parameters:

polyline - com.esri.arcgis.geometry.Polyline

Returns:

JSONObject JSON representation of input Polyline

Throws:

java.lang.Exception

getJSONFromPolygon

public static JSONObject getJSONFromPolygon(Polygon polygon)
                                     throws java.lang.Exception

Returns JSON representation of a Polygon object

Parameters:

polygon - com.esri.arcgis.geometry.Polygon

Returns:

JSONObject JSON representation of input Polygon

Throws:

java.lang.Exception

getJSONFromFeature

public static JSONObject getJSONFromFeature(Feature feature)
                                     throws java.lang.Exception

Returns JSON representation of a Feature object

Parameters:

feature -

Returns:

Throws:

java.lang.Exception

getJSONFromGeometry

public static JSONObject getJSONFromGeometry(IGeometry geometry)
                                      throws java.lang.Exception

Returns JSON representation of specified geometry

Parameters:

geometry -

Returns:

Throws:

java.lang.Exception

getJSONFromEnvelope

public static JSONObject getJSONFromEnvelope(Envelope env)

Retrieves JSON from Envelope

Parameters:

env -

Returns:

getPointFromJSON

public static Point getPointFromJSON(JSONObject pointJSON)
                              throws java.lang.Exception

Extracts Point geometry from specified JSONObject

Parameters:

json - Input JSON object that contains geometry as sole member. Valid JSON format for Point is:

 {
    "x" : -118.15, "y" : 33.80, "spatialReference" : {"wkid" : 4326}
 }
 

Returns:

com.esri.arcgis.geometry.Point

Throws:

java.lang.Exception

getMultipointFromJSON

public static Multipoint getMultipointFromJSON(JSONObject multipointJSON)
                                        throws java.lang.Exception

Extracts MultiPoint geometry from specified JSONObject

Parameters:

multipointJSON - Input JSON object that contains geometry as sole member. Valid JSON format for Multipoint is:

 {
"points" : [ [-97.06138,32.837], [-97.06133,32.836], [-97.06124,32.834], [-97.06127,32.832] ],
 "spatialReference" : {"wkid" : 4326}
 }

Returns:

com.esri.arcgis.geometry.Multipoint

Throws:

java.lang.Exception

getPolylineFomJSON

public static Polyline getPolylineFomJSON(JSONObject polylineJSON)
                                   throws java.lang.Exception

Extracts Polyline geometry from specified JSONObject

Parameters:

polylineJSON - Input JSON object that contains geometry as sole member. Valid JSON format for Polyline is:

 {
 "paths" : [ 
  [ [-97.06138,32.837], [-97.06133,32.836], [-97.06124,32.834], [-97.06127,32.832] ], 
 [ [-97.06326,32.759], [-97.06298,32.755] ]
 ],
 "spatialReference" : {"wkid" : 4326}
 }

Returns:

com.esri.arcgis.geometry.Polyline

Throws:

java.lang.Exception

getPolygonFomJSON

public static Polygon getPolygonFomJSON(JSONObject polygonJSON)
                                 throws java.lang.Exception

Extracts Polygon geometry from specified JSONObject

Parameters:

polygonJSON - Input JSON object that contains geometry as sole member. Valid JSON format for Polygon is:

 {
        "rings" : [ 
         [ [-97.06138,32.837], [-97.06133,32.836], [-97.06124,32.834], [-97.06127,32.832], [-97.06138,32.837] ], 
         [ [-97.06326,32.759], [-97.06298,32.755], [-97.06153,32.749], [-97.06326,32.759] ]
        ],
        "spatialReference" : {"wkid" : 4326}
        }
        

Returns:

com.esri.arcgis.geometry.Polygon

Throws:

java.lang.Exception

getGeometryFromJSON

public static IGeometry getGeometryFromJSON(JSONObject geometryJSON)
                                     throws java.lang.Exception

Returns an IGeometry given a JSON Object

Parameters:

geometryJSON -

Returns:

IGeometry

Throws:

java.lang.Exception

getEnvelopeFromJSON

public static Envelope getEnvelopeFromJSON(JSONObject jobj)

Retrieves Envelope from JSON

Parameters:

jobj -

Returns:

createResource

public static JSONObject createResource(java.lang.String name,
                                        java.lang.String description,
                                        boolean isCollection,
                                        boolean isDefaultCollection)

Creates a REST resource based on specified name, description and collection flag

Parameters:

name -

description -

isCollection -

Returns:

REST resource as a JSONObject

createOperation

public static JSONObject createOperation(java.lang.String operationName,
                                         java.lang.String parameterList,
                                         java.lang.String supportedOutputFormatsList,
                                         boolean postOnly)

Creates an operation that can be called on a REST resource, using specified name, parameter list and output formats list

Parameters:

operationName -

parameterList -

supportedOutputFormatsList -

Returns:

Operation as a JSONObject

sendError

public static java.lang.String sendError(int codeNumber,
                                         java.lang.String errorMessageSummary,
                                         java.lang.String[] errorMessageDetails)

Sends error message back to client in proper JSON format, which is as follows * { "error": { "code": 400, "message": "Cannot perform query. Invalid query parameters.", "details": ["'time' param is invalid"] } }

Parameters:

codeNumber - - Error code. Could be part of a user defined error hierarchy.

message - - Message containing summary of error for the client application. This cannot be null or invalid.

details - - Error details that are not part of summary. This can be null.

Returns:

getServerUserInfo

public static IServerUserInfo getServerUserInfo()

Returns an IServerUserInfo, which can be used to retrieve security info such as user name and the role the user name belongs to.

getServerLogger

public static ILog2 getServerLogger()

Returns a handle to ArcGIS Server's log file via the ILog2 interface. ArcGIS Java extensions running in ArcGIS Server should write to the Server's log file through the ILog2 interface obtained from this method.

Returns:

ILog2 or null if this method is not called from within ArcGIS Server.

getGroupInfo

public static java.util.Set getGroupInfo()

Provides user group information by leveraging Sharing API This method can be directly called from the main SOI class (usage: Set roles = ServerUtilities.getGroupInfo();)

Returns:

java.util.Set containing the group information.