org.apache.ambari.server.api.services

Class BaseService

java.lang.Object

org.apache.ambari.server.api.services.BaseService

Direct Known Subclasses:

ActionService, ActiveWidgetLayoutService, AlertDefinitionService, AlertGroupService, AlertHistoryService, AlertNoticeService, AlertService, AlertTargetService, BlueprintService, ClusterKerberosDescriptorService, ClusterService, ClusterStackVersionService, CompatibleRepositoryVersionService, ComponentService, ConfigGroupService, ConfigurationService, CredentialService, ExtensionLinksService, ExtensionsService, FeedService, GroupPrivilegeService, GroupService, HostComponentService, HostKerberosIdentityService, HostService, HostStackVersionService, InstanceService, JobService, KerberosDescriptorService, LdapSyncEventService, LoggingService, MemberService, MpacksService, OperatingSystemService, PermissionService, PreUpgradeCheckService, PrivilegeService, RecommendationService, RemoteClustersService, RepositoryService, RepositoryVersionService, RequestScheduleService, RequestService, RoleAuthorizationService, RootServiceComponentConfigurationService, RootServiceService, ServiceConfigVersionService, ServiceService, SettingService, StackAdvisorCommand, StacksService, StageService, TargetClusterService, TaskAttemptService, TaskService, UpgradeGroupService, UpgradeItemService, UpgradeService, UpgradeSummaryService, UserAuthenticationSourceService, UserAuthorizationService, UserPrivilegeService, UserService, ValidationService, VersionDefinitionService, ViewDataMigrationService, ViewExternalSubResourceService, ViewInstanceService, ViewPermissionService, ViewPrivilegeService, ViewService, ViewSubResourceService, ViewUrlsService, ViewVersionService, WidgetLayoutService, WidgetService, WorkflowService

public abstract class BaseService
extends Object

Provides common functionality to all services.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_TYPE_INT
static String	DATA_TYPE_STRING
static String	DEFAULT_FROM
static String	DEFAULT_PAGE_SIZE
static String	FIELDS_SEPARATOR
static javax.ws.rs.core.MediaType	MEDIA_TYPE_TEXT_CSV_TYPE
static String	MSG_CLUSTER_NOT_FOUND
static String	MSG_CLUSTER_OR_HOST_NOT_FOUND
static String	MSG_INVALID_ARGUMENTS
static String	MSG_INVALID_REQUEST
static String	MSG_NOT_AUTHENTICATED
static String	MSG_PERMISSION_DENIED
static String	MSG_REQUEST_ACCEPTED
static String	MSG_RESOURCE_ALREADY_EXISTS
static String	MSG_RESOURCE_NOT_FOUND
static String	MSG_SERVER_ERROR
static String	MSG_SUCCESSFUL_OPERATION
static String	MSG_VIEW_NOT_FOUND
static String	PARAM_TYPE_BODY
static String	PARAM_TYPE_QUERY
static String	QUERY_FIELDS
static String	QUERY_FILTER_DESCRIPTION
static String	QUERY_FROM
static String	QUERY_FROM_DESCRIPTION
static String	QUERY_FROM_VALUES
static String	QUERY_PAGE_SIZE
static String	QUERY_PAGE_SIZE_DESCRIPTION
static String	QUERY_PREDICATE
static String	QUERY_PREDICATE_DESCRIPTION
static String	QUERY_SORT
static String	QUERY_SORT_DESCRIPTION
static String	QUERY_TO
static String	QUERY_TO_DESCRIPTION
static String	QUERY_TO_TYPE
static String	QUERY_TO_VALUES
protected static RequestAuditLogger	requestAuditLogger
static String	RESPONSE_CONTAINER_LIST

Constructor Summary

Constructors

Constructor and Description
BaseService()

Method Summary

Modifier and Type	Method and Description
protected ResourceInstance	createResource(Resource.Type type, Map<Resource.Type,String> mapIds) Create a resource instance.
protected RequestBodyParser	getBodyParser()
protected ResultSerializer	getResultSerializer() Get the default serializer.
protected ResultSerializer	getResultSerializer(javax.ws.rs.core.MediaType mediaType) Get a serializer for the given media type.
protected javax.ws.rs.core.Response	handleRequest(javax.ws.rs.core.HttpHeaders headers, String body, javax.ws.rs.core.UriInfo uriInfo, Request.Type requestType, javax.ws.rs.core.MediaType mediaType, ResourceInstance resource) Requests are funneled through this method so that common logic can be executed.
protected javax.ws.rs.core.Response	handleRequest(javax.ws.rs.core.HttpHeaders headers, String body, javax.ws.rs.core.UriInfo uriInfo, Request.Type requestType, ResourceInstance resource) Requests are funneled through this method so that common logic can be executed.
static void	init(RequestAuditLogger instance)

Methods inherited from class java.lang.Object

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

Field Detail

MEDIA_TYPE_TEXT_CSV_TYPE

public static final javax.ws.rs.core.MediaType MEDIA_TYPE_TEXT_CSV_TYPE

MSG_SUCCESSFUL_OPERATION

public static final String MSG_SUCCESSFUL_OPERATION

See Also:

Constant Field Values

MSG_REQUEST_ACCEPTED

public static final String MSG_REQUEST_ACCEPTED

See Also:

Constant Field Values

MSG_INVALID_ARGUMENTS

public static final String MSG_INVALID_ARGUMENTS

See Also:

Constant Field Values

MSG_INVALID_REQUEST

public static final String MSG_INVALID_REQUEST

See Also:

Constant Field Values

MSG_CLUSTER_NOT_FOUND

public static final String MSG_CLUSTER_NOT_FOUND

See Also:

Constant Field Values

MSG_CLUSTER_OR_HOST_NOT_FOUND

public static final String MSG_CLUSTER_OR_HOST_NOT_FOUND

See Also:

Constant Field Values

MSG_VIEW_NOT_FOUND

public static final String MSG_VIEW_NOT_FOUND

See Also:

Constant Field Values

MSG_NOT_AUTHENTICATED

public static final String MSG_NOT_AUTHENTICATED

See Also:

Constant Field Values

MSG_PERMISSION_DENIED

public static final String MSG_PERMISSION_DENIED

See Also:

Constant Field Values

MSG_SERVER_ERROR

public static final String MSG_SERVER_ERROR

See Also:

Constant Field Values

MSG_RESOURCE_ALREADY_EXISTS

public static final String MSG_RESOURCE_ALREADY_EXISTS

See Also:

Constant Field Values

MSG_RESOURCE_NOT_FOUND

public static final String MSG_RESOURCE_NOT_FOUND

See Also:

Constant Field Values

QUERY_FIELDS

public static final String QUERY_FIELDS

See Also:

Constant Field Values

QUERY_FILTER_DESCRIPTION

public static final String QUERY_FILTER_DESCRIPTION

See Also:

Constant Field Values

QUERY_SORT

public static final String QUERY_SORT

See Also:

Constant Field Values

QUERY_SORT_DESCRIPTION

public static final String QUERY_SORT_DESCRIPTION

See Also:

Constant Field Values

QUERY_PAGE_SIZE

public static final String QUERY_PAGE_SIZE

See Also:

Constant Field Values

QUERY_PAGE_SIZE_DESCRIPTION

public static final String QUERY_PAGE_SIZE_DESCRIPTION

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

public static final String DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

QUERY_FROM

public static final String QUERY_FROM

See Also:

Constant Field Values

QUERY_FROM_DESCRIPTION

public static final String QUERY_FROM_DESCRIPTION

See Also:

Constant Field Values

QUERY_FROM_VALUES

public static final String QUERY_FROM_VALUES

See Also:

Constant Field Values

DEFAULT_FROM

public static final String DEFAULT_FROM

See Also:

Constant Field Values

QUERY_TO

public static final String QUERY_TO

See Also:

Constant Field Values

QUERY_TO_DESCRIPTION

public static final String QUERY_TO_DESCRIPTION

See Also:

Constant Field Values

QUERY_TO_TYPE

public static final String QUERY_TO_TYPE

See Also:

Constant Field Values

QUERY_TO_VALUES

public static final String QUERY_TO_VALUES

See Also:

Constant Field Values

QUERY_PREDICATE

public static final String QUERY_PREDICATE

See Also:

Constant Field Values

QUERY_PREDICATE_DESCRIPTION

public static final String QUERY_PREDICATE_DESCRIPTION

See Also:

Constant Field Values

RESPONSE_CONTAINER_LIST

public static final String RESPONSE_CONTAINER_LIST

See Also:

Constant Field Values

DATA_TYPE_INT

public static final String DATA_TYPE_INT

See Also:

Constant Field Values

DATA_TYPE_STRING

public static final String DATA_TYPE_STRING

See Also:

Constant Field Values

PARAM_TYPE_QUERY

public static final String PARAM_TYPE_QUERY

See Also:

Constant Field Values

PARAM_TYPE_BODY

public static final String PARAM_TYPE_BODY

See Also:

Constant Field Values

FIELDS_SEPARATOR

public static final String FIELDS_SEPARATOR

See Also:

Constant Field Values

requestAuditLogger

protected static RequestAuditLogger requestAuditLogger

Constructor Detail

BaseService

public BaseService()

Method Detail

init

public static void init(RequestAuditLogger instance)

handleRequest

protected javax.ws.rs.core.Response handleRequest(javax.ws.rs.core.HttpHeaders headers,
                                                  String body,
                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                  Request.Type requestType,
                                                  ResourceInstance resource)

Requests are funneled through this method so that common logic can be executed. Creates a request instance and invokes it's process method. Uses the default media type.

Parameters:

headers - http headers

body - http body

uriInfo - uri information

requestType - http request type

resource - resource instance that is being acted on

Returns:

the response of the operation in serialized form

handleRequest

protected javax.ws.rs.core.Response handleRequest(javax.ws.rs.core.HttpHeaders headers,
                                                  String body,
                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                  Request.Type requestType,
                                                  javax.ws.rs.core.MediaType mediaType,
                                                  ResourceInstance resource)

Requests are funneled through this method so that common logic can be executed. Creates a request instance and invokes it's process method.

Parameters:

headers - http headers

body - http body

uriInfo - uri information

requestType - http request type

mediaType - the requested media type; may be null

resource - resource instance that is being acted on

Returns:

the response of the operation in serialized form

createResource

protected ResourceInstance createResource(Resource.Type type,
                                          Map<Resource.Type,String> mapIds)

Create a resource instance.

Parameters:

type - the resource type

mapIds - all primary and foreign key properties and values

Returns:

a newly created resource instance

getResultSerializer

protected ResultSerializer getResultSerializer(javax.ws.rs.core.MediaType mediaType)

Get a serializer for the given media type.

Parameters:

mediaType - the media type

Returns:

the result serializer

getResultSerializer

protected ResultSerializer getResultSerializer()

Get the default serializer.

Returns:

the default serializer

getBodyParser

protected RequestBodyParser getBodyParser()