java.com.ionic.sdk.agent.request.getkey.GetKeysRequest 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.getkey;

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

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

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

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

    /**
     * Represents a list of External Key objects for an Agent.getKeys() request.
     */
    private final List externalIds;

    /**
     * Constructor.
     */
    public GetKeysRequest() {
        this.keyIds = new ArrayList();
        this.externalIds = new ArrayList();
    }

    /**
     * @return a list of Key objects for an Agent.getKeys() request.
     */
    public final List getKeyIds() {
        return keyIds;
    }

    /**
     * Add a key request object to the {@link GetKeysRequest}.
     *
     * @param keyId the object containing the parameters of the key request
     */
    public final void add(final String keyId) {
        keyIds.add(keyId);
    }

    /**
     * @return a list of Key objects for an Agent.getKeys() request.
     */
    public final List getExternalIds() {
        return externalIds;
    }

    /**
     * Add an external key request object to the {@link GetKeysRequest}.
     *
     * @param externalId the object containing the parameters of the key request
     */
    public final void addExternalId(final String externalId) {
        externalIds.add(externalId);
    }
}