java.com.ionic.sdk.agent.request.getresources.GetResourcesRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ionic-sdk Show documentation
The Ionic Java SDK provides an easy-to-use interface to the Ionic Platform.
There is a newer version: 2.9.0
package com.ionic.sdk.agent.request.getresources;

import com.ionic.sdk.agent.request.base.AgentRequestBase;

import java.util.ArrayList;
import java.util.List;

/**
 * Represents the input for an Agent.getResources() request.
 */
public class GetResourcesRequest extends AgentRequestBase {

    /**
     * Represents a list of Key objects for an Agent.createKeys() request.
     */
    private final List resources;

    /**
     * Constructor.
     */
    public GetResourcesRequest() {
        this.resources = new ArrayList();
    }

    /**
     * @return a list of Resource objects for an Agent.getResources() request.
     */
    public final List getResources() {
        return resources;
    }

    /**
     * Add a resource request object to the {@link GetResourcesRequest}.
     *
     * @param resource the object containing the parameters of the resource request
     */
    public final void add(final Resource resource) {
        resources.add(resource);
    }

    /**
     * Retrieve the key request with the matching refId.
     *
     * @param refId an identifier to correlate the request
     * @return the matching key request
     */
    public final Resource getResource(final String refId) {
        Resource resource = null;
        for (Resource resourceIt : resources) {
            if (refId.equals(resourceIt.getRefId())) {
                resource = resourceIt;
                break;
            }
        }
        return resource;
    }

    /**
     * Represents a discrete resource object.
     */
    public static class Resource {

        /**
         * A reference to be used to associate resources received in the response with the request.
         */
        private final String refId;

        /**
         * ID for type of resource being requested.
         * e.g. "markings", "marking-values", "coverpage"
         */
        private final String resourceId;

        /**
         * Supplementary arguments associated with the resource request.
         */
        private final String args;

        /**
         * Constructor.
         *
         * @param refId      reference used to associate request with response data
         * @param resourceId ID for requested resource type
         */
        public Resource(final String refId, final String resourceId) {
            this(refId, resourceId, null);
        }

        /**
         * Constructor.
         *
         * @param refId      reference used to associate request with response data
         * @param resourceId ID for requested resource type
         * @param args       supplementary arguments associated with the request
         */
        public Resource(final String refId, final String resourceId, final String args) {
            this.refId = refId;
            this.resourceId = resourceId;
            this.args = args;
        }

        /**
         * @return the reference used to associate individual resource requests with response data
         */
        public final String getRefId() {
            return ((refId == null) ? "" : refId);
        }

        /**
         * @return the id associated with the requested resource
         */
        public final String getResourceId() {
            return ((resourceId == null) ? "" : resourceId);
        }

        /**
         * @return the args associated with the resource request
         */
        public final String getArgs() {
            return ((args == null) ? "" : args);
        }
    }
}