com.tangosol.internal.management.resources.StorageManagerResource Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of coherence Show documentation
Show all versions of coherence Show documentation
Oracle Coherence Community Edition
/*
* Copyright (c) 2023, Oracle and/or its affiliates.
*
* Licensed under the Universal Permissive License v 1.0 as shown at
* https://oss.oracle.com/licenses/upl.
*/
package com.tangosol.internal.management.resources;
import com.tangosol.internal.http.HttpRequest;
import com.tangosol.internal.http.RequestRouter;
import com.tangosol.internal.http.Response;
import com.tangosol.internal.management.Converter;
import com.tangosol.internal.management.EntityMBeanResponse;
import com.tangosol.net.CacheFactory;
import com.tangosol.net.management.MBeanAccessor.QueryBuilder;
import com.tangosol.util.Filter;
import com.tangosol.util.filter.AlwaysFilter;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
import java.net.URI;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
/**
* Handles management API requests for a storage manager in a service.
*/
public class StorageManagerResource
extends AbstractManagementResource
{
// ----- Routes methods --------------------------------------------------
@Override
public void addRoutes(RequestRouter router, String sPathRoot)
{
router.addGet(sPathRoot, this::get);
router.addPost(sPathRoot + "/" + CLEAR, this::clearCache);
router.addPost(sPathRoot + "/" + TRUNCATE, this::truncateCache);
router.addPost(sPathRoot + "/" + RESET_STATS, this::resetStatistics);
}
// ----- GET API ---------------------------------------------------------
/**
* Return the aggregated metrics of StorageManagerMBean's for a single cache belonging to a Service.
*
* @param request the {@link HttpRequest}
*
* @return the response object
*/
public Response get(HttpRequest request)
{
String sCacheName = request.getFirstPathParameter(CACHE_NAME);
String sRoleName = request.getFirstQueryParameter(ROLE_NAME);
String sCollector = request.getFirstQueryParameter(COLLECTOR);
String sServiceName = request.getPathParameters().getFirst(SERVICE_NAME);
QueryBuilder queryBuilder = getQuery(request, sCacheName, sServiceName);
Set setObjectNames = ensureBeanAccessor(request).queryKeys(queryBuilder.build());
if (setObjectNames == null || setObjectNames.isEmpty())
{
return Response.status(Response.Status.NOT_FOUND).build();
}
EntityMBeanResponse responseEntity = createResponse(request, getParentUri(request), getCurrentUri(request), getLinksFilter(request));
addObjectNamesToResponse(request, setObjectNames, responseEntity);
Map mapResponse = responseEntity.toJson();
// aggregate cache and storage metrics into the response, storage manage metrics is always sent along with cache
addAggregatedMetricsToResponseMap(request, sRoleName, sCollector, queryBuilder, mapResponse);
return response(mapResponse);
}
// ----- POST API(Operations) --------------------------------------------
/**
* Call "resetStatistics" operation on StorageManagerMBean for all members.
*
* @param request the {@link HttpRequest}
*
* @return the response object
*/
public Response resetStatistics(HttpRequest request)
{
String sCacheName = request.getFirstPathParameter(CACHE_NAME);
String sServiceName = request.getPathParameters().getFirst(SERVICE_NAME);
QueryBuilder queryBuilder = getQuery(request, sCacheName, sServiceName);
return executeMBeanOperation(request, queryBuilder, RESET_STATS, null, null);
}
// ----- POST API(Clear) -------------------------------------------------
/**
* Call "clearCache" operation on StorageManagerMBean for all members.
*
* @param request the {@link HttpRequest}
*
* @return the response object
*/
public Response clearCache(HttpRequest request)
{
String sCacheName = request.getFirstPathParameter(CACHE_NAME);
String sServiceName = request.getPathParameters().getFirst(SERVICE_NAME);
QueryBuilder queryBuilder = getQuery(request, sCacheName, sServiceName);
return executeMBeanOperation(request, queryBuilder, "clearCache", null, null);
}
// ----- POST API(Truncate) ----------------------------------------------
/**
* Call "truncateCache" operation on StorageManagerMBean for all members.
*
* @param request the {@link HttpRequest}
*
* @return the response object
*/
public Response truncateCache(HttpRequest request)
{
String sCacheName = request.getFirstPathParameter(CACHE_NAME);
String sServiceName = request.getPathParameters().getFirst(SERVICE_NAME);
QueryBuilder queryBuilder = getQuery(request, sCacheName, sServiceName);
return executeMBeanOperation(request, queryBuilder, "truncateCache", null, null);
}
// ----- AbstractManagementResource methods ------------------------------
@SuppressWarnings({"rawtypes", "unchecked"})
@Override
protected EntityMBeanResponse getQueryResult(HttpRequest request,
URI uriParent,
URI uriCurrent,
Map mapQuery,
Map mapArguments)
{
String sCacheName = mapArguments.get(CACHE);
// collect attributes from the ObjectNames
URI uriSelf = getSubUri(uriParent, sCacheName);
Filter filterLinks = getLinksFilter(request, mapQuery);
String sServiceName = request.getPathParameters().getFirst(SERVICE_NAME);
QueryBuilder queryBuilder = getQuery(request, sCacheName, sServiceName);
Set setObjectNames = ensureBeanAccessor(request).queryKeys(queryBuilder.build());
if (setObjectNames == null || setObjectNames.isEmpty())
{
return null;
}
EntityMBeanResponse responseEntity = createResponse(request, uriParent, uriSelf, filterLinks);
addObjectNamesToResponse(request, setObjectNames, responseEntity);
Map mapEntity = responseEntity.getEntity();
addAggregatedMetricsToResponseMap(request, "*", null, queryBuilder, mapEntity);
return responseEntity;
}
// ----- StorageManagerResource methods ----------------------------------
/**
* MBean query to retrieve StorageManagerMBeans for the provided cache.
*
* @param request the request
* @param sCacheName the cache name
* @param sServiceName the service name
*
* @return the MBean query
*/
protected QueryBuilder getQuery(HttpRequest request, String sCacheName, String sServiceName)
{
return createQueryBuilder(request)
.withBaseQuery(String.format(STORAGE_MANAGERS_QUERY, sCacheName))
.withService(sServiceName);
}
/**
* Add attributes from the ObjectNames to the given EntityMBeanResponse.
*
* @param request the {@link HttpRequest}
* @param setObjectNames the set of ObjectNames from which to add to the response
* @param responseEntity the EntityMBeanResponse to add attributes to
*/
@SuppressWarnings({"unchecked", "rawtypes"})
protected void addObjectNamesToResponse(HttpRequest request,
Set setObjectNames,
EntityMBeanResponse responseEntity)
{
Filter filterAttributes = getAttributesFilter(request);
Map mapAttributes = new LinkedHashMap<>();
// return name, service, and node_id if no field is specified
if (filterAttributes instanceof AlwaysFilter)
{
filterAttributes = getAttributesFilter(String.join(",", CACHE, SERVICE, NODE_ID), null);
}
for (String sName : setObjectNames)
{
try
{
ObjectName objectName = new ObjectName(sName);
for (String sKey : objectName.getKeyPropertyList().keySet())
{
if (filterAttributes.evaluate(sKey))
{
Object oValue = Converter.convert(objectName.getKeyProperty(sKey));
Object oCurrent = mapAttributes.get(sKey);
if (oCurrent == null)
{
mapAttributes.put(sKey, oValue);
}
else if (oCurrent instanceof Set)
{
((Set) oCurrent).add(oValue);
}
else if (!Objects.equals(oCurrent, oValue))
{
Set values = new HashSet<>();
values.add(oCurrent);
values.add(oValue);
mapAttributes.put(sKey, values);
}
}
}
}
catch (MalformedObjectNameException e)
{
CacheFactory.log("Exception occurred while creating an ObjectName " +
sName + "\n" + CacheFactory.getStackTrace(e));
}
}
responseEntity.setEntity(mapAttributes);
}
}