org.odpi.openmetadata.accessservices.glossaryview.server.spring

Class GlossaryResource

java.lang.Object

org.odpi.openmetadata.accessservices.glossaryview.server.spring.GlossaryResource

@RestController
 @Validated
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/glossary-view/users/{userId}")
public class GlossaryResource
extends Object

Spring Rest Controller defining 'Glossary' oriented endpoints

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAGE_FROM_DEFAULT_VALUE
static String	PAGE_SIZE_DEFAULT_VALUE
static int	PAGE_SIZE_MAX_VALUE

Constructor Summary

Constructors

Constructor and Description
GlossaryResource() Called by Spring

Method Summary

Modifier and Type	Method and Description
GlossaryViewEntityDetailResponse	getAllGlossaries(String serverName, String userId, @PositiveOrZero Integer from, @PositiveOrZero @Max(value=10000L) Integer size) Extract all glossary definitions
GlossaryViewEntityDetailResponse	getCategoryHomeGlossary(String serverName, String userId, @NotBlank String categoryGUID) Extract a category's home glossary
GlossaryViewEntityDetailResponse	getExternalGlossaryLinks(String serverName, String userId, @NotBlank String glossaryGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(value=10000L) Integer size) Extract the external glossary link definitions
GlossaryViewEntityDetailResponse	getGlossary(String serverName, String userId, @NotBlank String glossaryGUID) Extract a glossary definition
GlossaryViewEntityDetailResponse	getTermHomeGlossary(String serverName, String userId, @NotBlank String termGUID) Extract a term's home glossary

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_FROM_DEFAULT_VALUE

public static final String PAGE_FROM_DEFAULT_VALUE

See Also:

Constant Field Values

PAGE_SIZE_DEFAULT_VALUE

public static final String PAGE_SIZE_DEFAULT_VALUE

See Also:

Constant Field Values

PAGE_SIZE_MAX_VALUE

public static final int PAGE_SIZE_MAX_VALUE

See Also:

Constant Field Values

Constructor Detail

GlossaryResource

public GlossaryResource()

Called by Spring

Method Detail

getAllGlossaries

@RequestMapping(method=GET,
                path="/glossaries")
public GlossaryViewEntityDetailResponse getAllGlossaries(@PathVariable(value="serverName")
                                                                                                                         String serverName,
                                                                                                                         @PathVariable(value="userId")
                                                                                                                         String userId,
                                                                                                                         @RequestParam(name="from",defaultValue="0") @PositiveOrZero
                                                                                                                         @PositiveOrZero Integer from,
                                                                                                                         @RequestParam(name="size",defaultValue="1000") @PositiveOrZero @Max(value=10000L)
                                                                                                                         @PositiveOrZero @Max(value=10000L) Integer size)

Extract all glossary definitions

Parameters:

serverName - instance to call

userId - calling user

from - from

size - size

Returns:

glossaries

getGlossary

@RequestMapping(method=GET,
                path="/glossaries/{glossaryGUID}")
public GlossaryViewEntityDetailResponse getGlossary(@PathVariable(value="serverName")
                                                                                                                                   String serverName,
                                                                                                                                   @PathVariable(value="userId")
                                                                                                                                   String userId,
                                                                                                                                   @PathVariable(value="glossaryGUID") @NotBlank
                                                                                                                                   @NotBlank String glossaryGUID)

Extract a glossary definition

Parameters:

serverName - instance to call

userId - calling user

glossaryGUID - glossary GUID

Returns:

a glossary

getTermHomeGlossary

@RequestMapping(method=GET,
                path="/terms/{termGUID}/home-glossary")
public GlossaryViewEntityDetailResponse getTermHomeGlossary(@PathVariable(value="serverName")
                                                                                                                                                String serverName,
                                                                                                                                                @PathVariable(value="userId")
                                                                                                                                                String userId,
                                                                                                                                                @PathVariable(value="termGUID") @NotBlank
                                                                                                                                                @NotBlank String termGUID)

Extract a term's home glossary

Parameters:

serverName - instance to call

userId - calling user

termGUID - term GUID

Returns:

glossaries

getCategoryHomeGlossary

@RequestMapping(method=GET,
                path="/categories/{categoryGUID}/home-glossary")
public GlossaryViewEntityDetailResponse getCategoryHomeGlossary(@PathVariable(value="serverName")
                                                                                                                                                             String serverName,
                                                                                                                                                             @PathVariable(value="userId")
                                                                                                                                                             String userId,
                                                                                                                                                             @PathVariable(value="categoryGUID") @NotBlank
                                                                                                                                                             @NotBlank String categoryGUID)

Extract a category's home glossary

Parameters:

serverName - instance to call

userId - calling user

categoryGUID - category GUID

Returns:

glossaries

getExternalGlossaryLinks

@RequestMapping(method=GET,
                path="/glossaries/{glossaryGUID}/external-glossary-links")
public GlossaryViewEntityDetailResponse getExternalGlossaryLinks(@PathVariable(value="serverName")
                                                                                                                                                                        String serverName,
                                                                                                                                                                        @PathVariable(value="userId")
                                                                                                                                                                        String userId,
                                                                                                                                                                        @PathVariable(value="glossaryGUID") @NotBlank
                                                                                                                                                                        @NotBlank String glossaryGUID,
                                                                                                                                                                        @RequestParam(name="from",defaultValue="0") @PositiveOrZero
                                                                                                                                                                        @PositiveOrZero Integer from,
                                                                                                                                                                        @RequestParam(name="size",defaultValue="1000") @PositiveOrZero @Max(value=10000L)
                                                                                                                                                                        @PositiveOrZero @Max(value=10000L) Integer size)

Extract the external glossary link definitions

Parameters:

serverName - instance to call

userId - calling user

glossaryGUID - glossary GUID

from - from

size - size

Returns:

external glossary links