Examples with QoSTransitionEngine org.dcache.qos.QoSTransitionEngine used on opensource projects

Example 1 with QoSTransitionEngine

use of org.dcache.qos.QoSTransitionEngine in project dcache by dCache.

the class FileResources method cmrResources.

@POST
@ApiOperation(value = "Modify a file or directory.")
@Path("{path : .*}")
@ApiResponses({ @ApiResponse(code = 400, message = "Transition for directories not supported"), @ApiResponse(code = 400, message = "Unsupported QoS transition"), @ApiResponse(code = 400, message = "Unknown target QoS"), @ApiResponse(code = 400, message = "Unknown action"), @ApiResponse(code = 401, message = "Unauthorized"), @ApiResponse(code = 403, message = "Forbidden"), @ApiResponse(code = 404, message = "Not Found"), @ApiResponse(code = 409, message = "Attribute already exists"), @ApiResponse(code = 409, message = "No such attribute"), @ApiResponse(code = 500, message = "Internal Server Error") })
@Consumes({ MediaType.APPLICATION_JSON })
@Produces(MediaType.APPLICATION_JSON)
public Response cmrResources(@ApiParam(value = "Path of file or directory to be modified.", required = true) @PathParam("path") String requestPath, @ApiParam(value = "A JSON object that has an 'action' " + "item with a String value.\n" + "\n" + "If the 'action' value is 'mkdir' " + "then a new directory is created " + "with the name taken from the " + "value of the JSON object 'name' " + "item.  This directory is created " + "within the supplied path parameter, " + "which must be an existing directory.\n" + "\n" + "If action is 'mv' then the file " + "or directory specified by the path " + "parameter is moved and/or " + "renamed with the value of the JSON " + "object 'destination' item describing " + "the final location.  If the " + "'destination' value is a relative " + "path then it is resolved against " + "the path parameter value.\n" + "\n" + "If action is 'qos' then the value " + "of the JSON object 'target' item " + "describes the desired QoS." + "\n" + "If action is 'pin' then the default " + "value of lifetime is 0 and liftime-unit " + "SECONDS." + "\n" + "If action is 'rm-xattr' then " + "extended attributes of a file " + "or directory are removed as " + "given by the 'names' item.  The " + "'names' value is either a " + "string or an array of strings." + "\n" + "If action is 'set-xattr' then " + "extended attributes are created " + "or modified.  The optional " + "'mode' item controls whether to " + "create a new attribute (CREATE), " + "to modify an existing attribute " + "(MODIFY), or to assign the value " + "by either creating a new " + "attribute or modifying an " + "existing attribute (EITHER).  " + "EITHER is the default mode.  The " + "'attributes' item value is a JSON " + "Object with the new attributes," + "where the JSON Object's key is " + "the attribute name and the " + "corresponding JSON Object's " + "value is this attribute's value." + "\n" + "If action is 'set-label' then " + "a label is added to the" + "given file object." + "'label' item value is a String." + "\n" + "If action is 'rm-label' then the corresponding" + "label of a file is removed." + "The  'label' value is either a string." + "\n" + "If action is 'chgrp' then the " + "command requests the change of " + "group-owner of the target file " + "or directory.  The value of the " + "JSON object 'gid' item is the " + "numerical value of the desired " + "new group-owner." + "\n" + "If action is 'chmod' then the " + "command reqests the change of " + "the target file's or directory's " + "permissions.  The value of the " + "JSON object 'mode' item is the " + "numerical value of the desired " + "mode.", required = true, examples = @Example({ @ExampleProperty(mediaType = "MV", value = "{\n" + "    \"action\" : \"mv\",\n" + "    \"destination\" : \"../foo\"\n" + "}"), @ExampleProperty(mediaType = "MKDIR", value = "{\n" + "    \"action\" : \"mkdir\",\n" + "    \"name\" : \"new-subdir\"\n" + "}"), @ExampleProperty(mediaType = "QOS", value = "{\n" + "    \"action\" : \"qos\",\n" + "    \"target\" : \"DISK+TAPE\"\n" + "}"), @ExampleProperty(mediaType = "PIN", value = "{\n" + "    \"action\" : \"pin\",\n" + "    \"lifetime\" : \"number\"\n" + "    \"lifetime-unit\" : \"SECONDS|MINUTES|HOURS|DAYS\"\n" + "}"), @ExampleProperty(mediaType = "UNPIN", value = "{\n" + "    \"action\" : \"unpin\",\n" + "}"), @ExampleProperty(mediaType = "SET-XATTR", value = "{\n" + "    \"action\" : \"set-xattr\",\n" + "    \"mode\" : \"CREATE\",\n" + "    \"attributes\" : {\n" + "        \"attr-1\": \"First attribute\",\n" + "        \"attr-2\": \"Second attribute\"\n" + "    }\n" + "}"), @ExampleProperty(mediaType = "RM-XATTR", value = "{\n" + "    \"action\" : \"rm-xattr\",\n" + "    \"names\" : [\n" + "        \"attr-1\",\n" + "        \"attr-2\"\n" + "    ]\n" + "}"), @ExampleProperty(mediaType = "SET-LABEL", value = "{\n" + "    \"action\" : \"set-label\",\n" + "    \"label\" : : \"label\",\n" + "}"), @ExampleProperty(mediaType = "RM-LABEL", value = "{\n" + "    \"action\" : \"rm-label\",\n" + "    \"label\" :  \"label\",\n" + "}"), @ExampleProperty(mediaType = "CHGRP", value = "{\n" + "    \"action\" : \"chgrp\",\n" + "    \"gid\" : 1000\n" + "}"), @ExampleProperty(mediaType = "CHMOD", value = "{\n" + "    \"action\" : \"chmod\",\n" + "    \"mode\" : 493\n" + "}") })) String requestPayload) {
    try {
        JSONObject reqPayload = new JSONObject(requestPayload);
        String action = (String) reqPayload.get("action");
        PnfsHandler pnfsHandler = HandlerBuilders.roleAwarePnfsHandler(pnfsmanager);
        FsPath path = pathMapper.asDcachePath(request, requestPath, ForbiddenException::new);
        PnfsId pnfsId;
        Long uid;
        switch(action) {
            case "mkdir":
                String name = (String) reqPayload.get("name");
                FsPath.checkChildName(name, BadRequestException::new);
                pnfsHandler = HandlerBuilders.pnfsHandler(// FIXME: non-role identity to ensure correct ownership
                pnfsmanager);
                pnfsHandler.createPnfsDirectory(path.child(name).toString());
                break;
            case "mv":
                String dest = (String) reqPayload.get("destination");
                FsPath target = pathMapper.resolve(request, path, dest);
                pnfsHandler.renameEntry(path.toString(), target.toString(), true);
                break;
            case "qos":
                String targetQos = reqPayload.getString("target");
                new QoSTransitionEngine(poolmanager, poolMonitor, pnfsHandler, pinmanager).adjustQoS(path, targetQos, request.getRemoteHost());
                break;
            case "pin":
                Integer lifetime = reqPayload.optInt("lifetime");
                if (lifetime == null) {
                    lifetime = 0;
                }
                String lifetimeUnitVal = reqPayload.optString("lifetime-unit");
                TimeUnit lifetimeUnit = lifetimeUnitVal == null ? TimeUnit.SECONDS : TimeUnit.valueOf(lifetimeUnitVal);
                pnfsId = pnfsHandler.getPnfsIdByPath(path.toString());
                /*
                     *  Fire-and-forget, as it was in 5.2
                     */
                pinmanager.notify(new PinManagerPinMessage(FileAttributes.ofPnfsId(pnfsId), getProtocolInfo(), getRequestId(), lifetimeUnit.toMillis(lifetime)));
                break;
            case "unpin":
                pnfsId = pnfsHandler.getPnfsIdByPath(path.toString());
                PinManagerUnpinMessage message = new PinManagerUnpinMessage(pnfsId);
                message.setRequestId(getRequestId());
                pinmanager.notify(message);
                break;
            case "rm-xattr":
                Object namesArgument = reqPayload.get("names");
                if (namesArgument instanceof String) {
                    pnfsHandler.removeExtendedAttribute(path, (String) namesArgument);
                } else if (namesArgument instanceof JSONArray) {
                    JSONArray namesArray = (JSONArray) namesArgument;
                    List<String> names = new ArrayList<>(namesArray.length());
                    for (int i = 0; i < namesArray.length(); i++) {
                        names.add(namesArray.getString(i));
                    }
                    pnfsHandler.removeExtendedAttribute(path, names);
                } else {
                    throw new JSONException("\"names\" is not a String or an array");
                }
                break;
            case "set-xattr":
                String modeString = reqPayload.optString("mode", "EITHER");
                Mode xattrSetMode = modeOf(modeString);
                JSONObject attributeOject = reqPayload.getJSONObject("attributes");
                Map<String, byte[]> attributes = new HashMap<>(attributeOject.length());
                for (String key : attributeOject.keySet()) {
                    String value = attributeOject.getString(key);
                    attributes.put(key, value.getBytes(StandardCharsets.UTF_8));
                }
                pnfsHandler.writeExtendedAttribute(path, attributes, xattrSetMode);
                break;
            case "set-label":
                String label = reqPayload.getString("label");
                pnfsHandler.setFileAttributes(path, FileAttributes.ofLabel(label));
                break;
            case "rm-label":
                String labelsArgument = reqPayload.getString("label");
                pnfsHandler.removeLabel(path, labelsArgument);
                break;
            case "chgrp":
                int gid = reqPayload.getInt("gid");
                pnfsHandler.setFileAttributes(path, FileAttributes.ofGid(gid));
                break;
            case "chmod":
                int mode = reqPayload.getInt("mode");
                pnfsHandler.setFileAttributes(path, FileAttributes.ofMode(mode));
                break;
            default:
                throw new UnsupportedOperationException("No such action " + action);
        }
    } catch (FileNotFoundCacheException e) {
        throw new NotFoundException(e);
    } catch (PermissionDeniedCacheException e) {
        if (RequestUser.isAnonymous()) {
            throw new NotAuthorizedException(e);
        } else {
            throw new ForbiddenException(e);
        }
    } catch (AttributeExistsCacheException e) {
        throw new WebApplicationException(Response.status(409, "Attribute already exist").build());
    } catch (NoAttributeCacheException e) {
        throw new WebApplicationException(Response.status(409, "No such attribute").build());
    } catch (UnsupportedOperationException | URISyntaxException | JSONException | CacheException | InterruptedException | NoRouteToCellException e) {
        throw new BadRequestException(e.getMessage(), e);
    }
    return successfulResponse(Response.Status.CREATED);
}

Example 2 with QoSTransitionEngine

use of org.dcache.qos.QoSTransitionEngine in project dcache by dCache.

the class UpdateQoSJob method doRun.

@Override
protected void doRun() {
    if (arguments == null) {
        setError(new IllegalArgumentException("no target qos given."));
        return;
    }
    String targetQos = arguments.get(TARGET_QOS.getName());
    if (targetQos == null) {
        setError(new IllegalArgumentException("no target qos given."));
        return;
    }
    QoSTransitionEngine engine = new QoSTransitionEngine(poolManager, poolMonitor, pnfsHandler, pinManager);
    replyHandler = new QoSJobReplyHandler(executorService);
    engine.setReplyHandler(replyHandler);
    try {
        engine.adjustQoS(path, targetQos, NetworkUtils.getCanonicalHostName());
    } catch (URISyntaxException | CacheException | NoRouteToCellException e) {
        setError(e);
        return;
    } catch (InterruptedException e) {
        errorObject = e;
        setState(State.CANCELLED);
        completionHandler.jobInterrupted(this);
        LOGGER.trace("doRun interrupted.");
        return;
    }
    if (replyHandler.done()) {
        setState(State.COMPLETED);
    } else {
        setState(State.WAITING);
    }
}

Example 3 with QoSTransitionEngine

use of org.dcache.qos.QoSTransitionEngine in project dcache by dCache.

the class NamespaceUtils method addQoSAttributes.

/**
 * <p>Add quality-of-service attributes (pinned, locality, etc.) </p>
 *
 * @param json        mapped from attributes
 * @param attributes  returned by the query to namespace
 * @param request     to check for client info
 * @param poolMonitor a PoolMonitor to check locality
 * @param pinmanager  communication with pinmanager
 */
public static void addQoSAttributes(JsonFileAttributes json, FileAttributes attributes, HttpServletRequest request, PoolMonitor poolMonitor, CellStub pinmanager) throws CacheException, NoRouteToCellException, InterruptedException {
    if (RequestUser.isAnonymous()) {
        throw new PermissionDeniedCacheException("Permission denied");
    }
    QosStatus status = new QoSTransitionEngine(poolMonitor, pinmanager).getQosStatus(attributes, request.getRemoteHost());
    json.setCurrentQos(status.getCurrent().displayName());
    Qos target = status.getTarget();
    if (target != null) {
        json.setTargetQos(target.displayName());
    }
}