1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.extras.extended.gracefulShutdown;
21
22
23 import org.apache.directory.api.ldap.model.message.ExtendedRequest;
24
25
26 /**
27 * An extended operation requesting the server to shutdown it's LDAP service
28 * port while allowing established clients to complete or abandon operations
29 * already in progress. More information about this extended request is
30 * available here: <a href="http://docs.safehaus.org:8080/x/GR">LDAP Extensions
31 * for Graceful Shutdown</a>.
32 *
33 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34 */
35 public interface GracefulShutdownRequest extends ExtendedRequest
36 {
37 /** The OID for the graceful shutdown extended operation request. */
38 String EXTENSION_OID = "1.3.6.1.4.1.18060.0.1.3";
39
40 /** Undetermined value used for offline time */
41 int UNDETERMINED = 0;
42
43 /** The shutdown is immediate */
44 int NOW = 0;
45
46
47 /**
48 * Gets the delay before disconnection, in seconds.
49 *
50 * @return the delay before disconnection
51 */
52 int getDelay();
53
54
55 /**
56 * Sets the delay before disconnection, in seconds.
57 *
58 * @param delay the new delay before disconnection
59 */
60 void setDelay( int delay );
61
62
63 /**
64 * Gets the offline time after disconnection, in minutes.
65 *
66 * @return the offline time after disconnection
67 */
68 int getTimeOffline();
69
70
71 /**
72 * Sets the time offline after disconnection, in minutes.
73 *
74 * @param timeOffline the new time offline after disconnection
75 */
76 void setTimeOffline( int timeOffline );
77
78 }