summaryrefslogtreecommitdiff
path: root/core/src/main/java/org/elasticsearch/action/support/tasks/BaseTasksRequest.java
blob: a1e485bb64f7818d05ae1c91172637cc9c098b80 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.action.support.tasks;

import org.elasticsearch.action.ActionRequest;
import org.elasticsearch.action.ActionRequestValidationException;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.regex.Regex;
import org.elasticsearch.common.unit.TimeValue;
import org.elasticsearch.tasks.ChildTask;
import org.elasticsearch.tasks.Task;

import java.io.IOException;

/**
 * A base class for task requests
 */
public class BaseTasksRequest<T extends BaseTasksRequest> extends ActionRequest<T> {


    public static final String[] ALL_ACTIONS = Strings.EMPTY_ARRAY;

    public static final String[] ALL_NODES = Strings.EMPTY_ARRAY;

    public static final long ALL_TASKS = -1L;

    private String[] nodesIds = ALL_NODES;

    private TimeValue timeout;

    private String[] actions = ALL_ACTIONS;

    private String parentNode;

    private long parentTaskId = ALL_TASKS;

    public BaseTasksRequest() {
    }

    @Override
    public ActionRequestValidationException validate() {
        return null;
    }

    /**
     * Get information about tasks from nodes based on the nodes ids specified.
     * If none are passed, information for all nodes will be returned.
     */
    public BaseTasksRequest(ActionRequest request, String... nodesIds) {
        super(request);
        this.nodesIds = nodesIds;
    }

    /**
     * Get information about tasks from nodes based on the nodes ids specified.
     * If none are passed, information for all nodes will be returned.
     */
    public BaseTasksRequest(String... nodesIds) {
        this.nodesIds = nodesIds;
    }

    /**
     * Sets the list of action masks for the actions that should be returned
     */
    @SuppressWarnings("unchecked")
    public final T actions(String... actions) {
        this.actions = actions;
        return (T) this;
    }

    /**
     * Return the list of action masks for the actions that should be returned
     */
    public String[] actions() {
        return actions;
    }

    public final String[] nodesIds() {
        return nodesIds;
    }

    @SuppressWarnings("unchecked")
    public final T nodesIds(String... nodesIds) {
        this.nodesIds = nodesIds;
        return (T) this;
    }

    /**
     * Returns the parent node id that tasks should be filtered by
     */
    public String parentNode() {
        return parentNode;
    }

    @SuppressWarnings("unchecked")
    public T parentNode(String parentNode) {
        this.parentNode = parentNode;
        return (T) this;
    }

    /**
     * Returns the parent task id that tasks should be filtered by
     */
    public long parentTaskId() {
        return parentTaskId;
    }

    @SuppressWarnings("unchecked")
    public T parentTaskId(long parentTaskId) {
        this.parentTaskId = parentTaskId;
        return (T) this;
    }


    public TimeValue timeout() {
        return this.timeout;
    }

    @SuppressWarnings("unchecked")
    public final T timeout(TimeValue timeout) {
        this.timeout = timeout;
        return (T) this;
    }

    @SuppressWarnings("unchecked")
    public final T timeout(String timeout) {
        this.timeout = TimeValue.parseTimeValue(timeout, null, getClass().getSimpleName() + ".timeout");
        return (T) this;
    }

    @Override
    public void readFrom(StreamInput in) throws IOException {
        super.readFrom(in);
        nodesIds = in.readStringArray();
        actions = in.readStringArray();
        parentNode = in.readOptionalString();
        parentTaskId = in.readLong();
        if (in.readBoolean()) {
            timeout = TimeValue.readTimeValue(in);
        }
    }

    @Override
    public void writeTo(StreamOutput out) throws IOException {
        super.writeTo(out);
        out.writeStringArrayNullable(nodesIds);
        out.writeStringArrayNullable(actions);
        out.writeOptionalString(parentNode);
        out.writeLong(parentTaskId);
        out.writeOptionalStreamable(timeout);
    }

    public boolean match(Task task) {
        if (actions() != null && actions().length > 0 && Regex.simpleMatch(actions(), task.getAction()) == false) {
            return false;
        }
        if (parentNode() != null || parentTaskId() != BaseTasksRequest.ALL_TASKS) {
            if (task instanceof ChildTask) {
                if (parentNode() != null) {
                    if (parentNode().equals(((ChildTask) task).getParentNode()) == false) {
                        return false;
                    }
                }
                if (parentTaskId() != BaseTasksRequest.ALL_TASKS) {
                    if (parentTaskId() != ((ChildTask) task).getParentId()) {
                        return false;
                    }
                }
            } else {
                // This is not a child task and we need to match parent node or id
                return false;
            }
        }
        return true;
    }
}