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.gracefulDisconnect;
21
22
23 import org.apache.directory.api.ldap.model.message.ExtendedResponse;
24 import org.apache.directory.api.ldap.model.message.Referral;
25
26
27 /**
28 * An unsolicited notification, extended response, intended for notifying
29 * clients of upcoming disconnection due to intended service windows. Unlike the
30 * {@link org.apache.directory.api.ldap.model.message.extended.NoticeOfDisconnect} this response contains additional information about
31 * the amount of time the server will be offline and exactly when it intends to
32 * shutdown.
33 *
34 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
35 */
36 public interface GracefulDisconnectResponse extends ExtendedResponse
37 {
38 /** The OID for the graceful disconnect extended operation response. */
39 String EXTENSION_OID = "1.3.6.1.4.1.18060.0.1.5";
40
41
42 /**
43 * Gets the delay before disconnection, in seconds.
44 *
45 * @return the delay before disconnection
46 */
47 int getDelay();
48
49
50 /**
51 * Sets the delay before disconnection, in seconds.
52 *
53 * @param delay the new delay before disconnection
54 */
55 void setDelay( int delay );
56
57
58 /**
59 * Gets the offline time after disconnection, in minutes.
60 *
61 * @return the offline time after disconnection
62 */
63 int getTimeOffline();
64
65
66 /**
67 * Sets the time offline after disconnection, in minutes.
68 *
69 * @param timeOffline the new time offline after disconnection
70 */
71 void setTimeOffline( int timeOffline );
72
73
74 /**
75 * Gets the replicated contexts.
76 *
77 * @return the replicated contexts
78 */
79 Referral getReplicatedContexts();
80
81
82 /**
83 * Add a new URL of a replicated server
84 *
85 * @param replicatedContext The replicated server to add.
86 */
87 void addReplicatedContexts( String replicatedContext );
88 }