summaryrefslogtreecommitdiffstats
path: root/rest-client/src/main/java/org/openo/baseservice/roa/util/restclient/RestfulOptions.java
blob: 912abf5e3273889ffa96ed27aead31a3bb7487df (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
196
/*
 * Copyright (c) 2016, Huawei Technologies Co., Ltd.
 *
 * Licensed 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.openo.baseservice.roa.util.restclient;

import java.util.HashMap;
import java.util.Map;

/**
 * Options for Rest communication.<br/>
 * <p>
 * </p>
 * 
 * @author
 * @version SDNO 0.5 28-May-2016
 */
public class RestfulOptions {

    public static final String REST_OPTIONS_NAME_TIMEOUT = "timeout";

    public static final int REST_OPTIONS_TIMEOUT_MAXTIMEOUT = 1800000;

    private final Map<String, Object> optionsMap = new HashMap<>();

    /**
     * Set called service name.<br/>
     * 
     * @param serviceName service name.
     * @return true.
     * @since SDNO 0.5
     */
    public boolean setCalledServiceName(final String serviceName) {
        this.setOption(RestfulClientConst.CALLED_SERVICE_NAME, serviceName);
        return true;
    }

    /**
     * Get called service name.<br/>
     * 
     * @return
     * @since SDNO 0.5
     */
    public String getCalledServicName() {
        final Object obj = this.getOption(RestfulClientConst.CALLED_SERVICE_NAME);
        if(null == obj) {
            return "";
        }
        return (String)obj;
    }

    /**
     * Get port.<br/>
     * 
     * @return port.
     * @since SDNO 0.5
     */
    public int getPort() {
        final Object obj = this.getOption(RestfulClientConst.PORT_KEY_NAME);
        if(null == obj) {
            return 0;
        }
        return ((Integer)obj).intValue();
    }

    /**
     * Set port.<br/>
     * 
     * @param port port to set.
     * @return
     * @since SDNO 0.5
     */
    public boolean setPort(final int port) {
        this.setOption(RestfulClientConst.PORT_KEY_NAME, port);
        return true;
    }

    /**
     * Get host.<br/>
     * 
     * @return the host.
     * @since SDNO 0.5
     */
    public String getHost() {
        final Object obj = this.getOption(RestfulClientConst.HOST_KEY_NAME);
        if(null == obj) {
            return "";
        }
        return (String)obj;
    }

    /**
     * Set host.<br/>
     * 
     * @param host host to set.
     * @return
     * @since SDNO 0.5
     */
    public boolean setHost(final String host) {
        this.setOption(RestfulClientConst.HOST_KEY_NAME, host);
        return true;
    }

    /**
     * Set rest time-out.<br/>
     * 
     * @param timeout time-out to set in seconds.
     * @return
     * @since SDNO 0.5
     */
    public boolean setRestTimeout(final int timeout) {
        if(0 < timeout && REST_OPTIONS_TIMEOUT_MAXTIMEOUT >= timeout) {
            this.setOption(REST_OPTIONS_NAME_TIMEOUT, timeout);
            return true;
        }
        return false;
    }

    /**
     * Get time-out.<br/>
     * 
     * @return time-out in seconds.
     * @since SDNO 0.5
     */
    public int getRestTimeout() {
        final Object obj = this.getOption(REST_OPTIONS_NAME_TIMEOUT);
        if(null == obj) {
            return 0;
        }
        return ((Integer)obj).intValue();
    }

    /**
     * Get specified option.<br/>
     * 
     * @param optionName option name.
     * @return option
     * @since SDNO 0.5
     */
    public Object getOption(final String optionName) {
        return optionsMap.get(optionName);
    }

    /**
     * Get option value as integer.<br/>
     * 
     * @param optionName option name.
     * @return option value as int.
     * @since SDNO 0.5
     */
    public int getIntOption(final String optionName) {
        final Object obj = this.getOption(optionName);
        if(null == obj) {
            return 0;
        }
        return ((Integer)obj).intValue();
    }

    /**
     * Get option value as string.<br/>
     * 
     * @param optionName option name.
     * @return option value as string.
     * @since SDNO 0.5
     */
    public String getStringOption(final String optionName) {
        final Object obj = this.getOption(optionName);
        if(null == obj) {
            return "";
        }
        return (String)obj;
    }

    /**
     * Set option.<br/>
     * 
     * @param option option name.
     * @param optionsValue option value.
     * @return
     * @since SDNO 0.5
     */
    public Object setOption(final String option, final Object optionsValue) {
        return optionsMap.put(option, optionsValue);
    }
}