svn commit: r373298 - /directory/trunks/common/ldap/src/main/java/org/apache/ldap/common/message/extended/GracefulShutdownRequest.java

[ak...@apache.org]

Author: akarasulu
Date: Sun Jan 29 01:19:55 2006
New Revision: 373298

URL: http://svn.apache.org/viewcvs?rev=373298&view=rev
Log:
adding the JNDI compatible representations of codec objects for graceful shutdowns

Added:
    directory/trunks/common/ldap/src/main/java/org/apache/ldap/common/message/extended/GracefulShutdownRequest.java

Added: directory/trunks/common/ldap/src/main/java/org/apache/ldap/common/message/extended/GracefulShutdownRequest.java
URL: http://svn.apache.org/viewcvs/directory/trunks/common/ldap/src/main/java/org/apache/ldap/common/message/extended/GracefulShutdownRequest.java?rev=373298&view=auto
==============================================================================
--- directory/trunks/common/ldap/src/main/java/org/apache/ldap/common/message/extended/GracefulShutdownRequest.java (added)
+++ directory/trunks/common/ldap/src/main/java/org/apache/ldap/common/message/extended/GracefulShutdownRequest.java Sun Jan 29 01:19:55 2006
@@ -0,0 +1,154 @@
+/*
+ *   Copyright 2006 The Apache Software Foundation
+ *
+ *   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.apache.ldap.common.message.extended;
+
+
+import javax.naming.NamingException;
+import javax.naming.ldap.ExtendedResponse;
+
+import org.apache.asn1.codec.EncoderException;
+import org.apache.ldap.common.codec.extended.operations.GracefulShutdown;
+import org.apache.ldap.common.message.ExtendedRequestImpl;
+import org.apache.ldap.common.message.ResultResponse;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+
+/**
+ * An extended operation requesting the server to shutdown it's LDAP service
+ * port while allowing established clients to complete or abandon operations
+ * already in progress. More information about this extended request is
+ * available here: <a href="ahttp://docs.safehaus.org:8080/x/GR">LDAP Extensions
+ * for Graceful Shutdown</a>.
+ * 
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$
+ */
+public class GracefulShutdownRequest extends ExtendedRequestImpl
+{
+    private static final Logger log = LoggerFactory.getLogger( GracefulShutdownRequest.class );
+    private static final long serialVersionUID = -4682291068700593492L;
+    public static final String OID = "1.2.6.1.4.1.18060.1.1.1.100.3";
+
+    /** Undetermined value used for timeOffline */
+    public static final int UNDETERMINED = 0;
+
+    /** The shutdown is immediate */
+    public static final int NOW = 0;
+
+    /** offline Time after disconnection */
+    private int timeOffline;
+
+    /** Delay before disconnection */
+    private int delay;
+
+
+    public GracefulShutdownRequest( int messageId )
+    {
+        this( messageId, UNDETERMINED, NOW );
+    }
+
+
+    public GracefulShutdownRequest( int messageId, int timeOffline, int delay )
+    {
+        super( messageId );
+        setOid( OID );
+        this.timeOffline = timeOffline;
+        this.delay = delay;
+    }
+    
+    
+    private void encodePayload() throws EncoderException
+    {
+        GracefulShutdown gs = new GracefulShutdown();
+        gs.setDelay( this.delay );
+        gs.setTimeOffline( this.timeOffline );
+        payload = gs.encode( null ).array();
+    }
+
+
+    public ExtendedResponse createExtendedResponse(String id, byte[] berValue, int offset, int length)
+        throws NamingException
+    {
+        return ( ExtendedResponse ) getResultResponse();
+    }
+
+
+    public byte[] getEncodedValue()
+    {
+        return getPayload();
+    }
+
+
+    public byte[] getPayload()
+    {
+        if ( payload == null )
+        {
+            try
+            {
+                encodePayload();
+            }
+            catch ( EncoderException e )
+            {
+                log.error( "Failed to encode payload GracefulShutdownRequest", e );
+            }
+        }
+        
+        return payload;
+    }
+
+
+    public ResultResponse getResultResponse()
+    {
+        if ( response == null )
+        {
+            response = new GracefulShutdownResponse( getMessageId() );
+        }
+        
+        return response;
+    }
+    
+    
+    // -----------------------------------------------------------------------
+    // Parameters of the Extended Request Payload
+    // -----------------------------------------------------------------------
+
+
+    public int getDelay()
+    {
+        return delay;
+    }
+
+
+    public void setDelay(int delay)
+    {
+        this.delay = delay;
+    }
+
+
+    public int getTimeOffline()
+    {
+        return timeOffline;
+    }
+
+
+    public void setTimeOffline(int timeOffline)
+    {
+        this.timeOffline = timeOffline;
+    }
+}