Java Service provides Java inspection service which generate an AtlasMap Document object from Java class name.
1. Endpoints
1.1. Default
1.1.1. inspectClass
POST /java/class
Inspect Class
Description
Inspect a Java Class with specified fully qualified class name and return a Document object
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ClassInspectionRequest |
ClassInspectionRequest object ClassInspectionRequest |
- |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Return a Document object represented by JavaClass |
Samples
1.1.2. simpleHelloWorld
GET /java/simple
Simple
Description
Simple hello service
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
From |
- |
null |
Return Type
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Return a response |
Samples
2. Models
2.1. Action
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
@type |
String |
2.2. ClassInspectionRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
fieldNameExclusions |
StringList |
|||
classNameExclusions |
StringList |
|||
classpath |
String |
|||
className |
String |
|||
collectionType |
String |
Enum: ALL, ARRAY, LIST, MAP, NONE, |
||
collectionClassName |
String |
|||
disablePrivateOnlyFields |
Boolean |
|||
disableProtectedOnlyFields |
Boolean |
|||
disablePublicOnlyFields |
Boolean |
|||
disablePublicGetterSetterFields |
Boolean |
|||
jsonType |
X |
String |
2.3. ClassInspectionResponse
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
javaClass |
JavaClass |
|||
errorMessage |
String |
|||
executionTime |
Long |
int64 |
||
jsonType |
X |
String |
2.4. JavaClass
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actions |
List of Action |
|||
value |
Object |
|||
arrayDimensions |
Integer |
int32 |
||
arraySize |
Integer |
int32 |
||
collectionType |
String |
Enum: ALL, ARRAY, LIST, MAP, NONE, |
||
docId |
String |
|||
index |
Integer |
int32 |
||
path |
String |
|||
required |
Boolean |
|||
status |
String |
Enum: SUPPORTED, UNSUPPORTED, CACHED, ERROR, NOT_FOUND, EXCLUDED, |
||
fieldType |
String |
Enum: ANY, ANY_DATE, BIG_INTEGER, BOOLEAN, BYTE, BYTE_ARRAY, CHAR, COMPLEX, DATE, DATE_TIME, DATE_TIME_TZ, DATE_TZ, DECIMAL, DOUBLE, FLOAT, INTEGER, LONG, NONE, NUMBER, SHORT, STRING, TIME, TIME_TZ, UNSIGNED_BYTE, UNSIGNED_INTEGER, UNSIGNED_LONG, UNSIGNED_SHORT, UNSUPPORTED, |
||
format |
String |
|||
name |
String |
|||
annotations |
StringList |
|||
modifiers |
ModifierList |
|||
parameterizedTypes |
StringList |
|||
className |
String |
|||
canonicalClassName |
String |
|||
collectionClassName |
String |
|||
getMethod |
String |
|||
setMethod |
String |
|||
primitive |
Boolean |
|||
synthetic |
Boolean |
|||
javaEnumFields |
JavaEnumFields |
|||
javaFields |
JavaFields |
|||
packageName |
String |
|||
annotation |
Boolean |
|||
annonymous |
Boolean |
|||
enumeration |
Boolean |
|||
localClass |
Boolean |
|||
memberClass |
Boolean |
|||
uri |
String |
|||
interface |
Boolean |
|||
jsonType |
X |
String |
2.5. JavaEnumField
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actions |
List of Action |
|||
value |
Object |
|||
arrayDimensions |
Integer |
int32 |
||
arraySize |
Integer |
int32 |
||
collectionType |
String |
Enum: ALL, ARRAY, LIST, MAP, NONE, |
||
docId |
String |
|||
index |
Integer |
int32 |
||
path |
String |
|||
required |
Boolean |
|||
status |
String |
Enum: SUPPORTED, UNSUPPORTED, CACHED, ERROR, NOT_FOUND, EXCLUDED, |
||
fieldType |
String |
Enum: ANY, ANY_DATE, BIG_INTEGER, BOOLEAN, BYTE, BYTE_ARRAY, CHAR, COMPLEX, DATE, DATE_TIME, DATE_TIME_TZ, DATE_TZ, DECIMAL, DOUBLE, FLOAT, INTEGER, LONG, NONE, NUMBER, SHORT, STRING, TIME, TIME_TZ, UNSIGNED_BYTE, UNSIGNED_INTEGER, UNSIGNED_LONG, UNSIGNED_SHORT, UNSUPPORTED, |
||
format |
String |
|||
name |
String |
|||
ordinal |
Integer |
int32 |
||
className |
String |
|||
jsonType |
X |
String |
2.6. JavaEnumFields
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
javaEnumField |
List of JavaEnumField |
2.7. JavaField
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actions |
List of Action |
|||
value |
Object |
|||
arrayDimensions |
Integer |
int32 |
||
arraySize |
Integer |
int32 |
||
collectionType |
String |
Enum: ALL, ARRAY, LIST, MAP, NONE, |
||
docId |
String |
|||
index |
Integer |
int32 |
||
path |
String |
|||
required |
Boolean |
|||
status |
String |
Enum: SUPPORTED, UNSUPPORTED, CACHED, ERROR, NOT_FOUND, EXCLUDED, |
||
fieldType |
String |
Enum: ANY, ANY_DATE, BIG_INTEGER, BOOLEAN, BYTE, BYTE_ARRAY, CHAR, COMPLEX, DATE, DATE_TIME, DATE_TIME_TZ, DATE_TZ, DECIMAL, DOUBLE, FLOAT, INTEGER, LONG, NONE, NUMBER, SHORT, STRING, TIME, TIME_TZ, UNSIGNED_BYTE, UNSIGNED_INTEGER, UNSIGNED_LONG, UNSIGNED_SHORT, UNSUPPORTED, |
||
format |
String |
|||
name |
String |
|||
annotations |
StringList |
|||
modifiers |
ModifierList |
|||
parameterizedTypes |
StringList |
|||
className |
String |
|||
canonicalClassName |
String |
|||
collectionClassName |
String |
|||
getMethod |
String |
|||
setMethod |
String |
|||
primitive |
Boolean |
|||
synthetic |
Boolean |
|||
jsonType |
X |
String |
2.8. JavaFields
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
javaField |
List of JavaField |
2.9. ModifierList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
modifier |
List of [string] |
Enum: |
2.10. StringList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
string |
List of [string] |