Author: bloritsch Date: Tue Dec 14 06:58:42 2004 New Revision: 111818 URL: http://svn.apache.org/viewcvs?view=rev&rev=111818 Log: add the protocol-api draft to SVN Added: incubator/directory/protocol-api/ incubator/directory/protocol-api/tags/ incubator/directory/protocol-api/trunk/ incubator/directory/protocol-api/trunk/INCUBATOR-DISCLAIMER.txt incubator/directory/protocol-api/trunk/LICENSE.txt incubator/directory/protocol-api/trunk/NOTICE.txt incubator/directory/protocol-api/trunk/src/ incubator/directory/protocol-api/trunk/src/java/ incubator/directory/protocol-api/trunk/src/java/org/ incubator/directory/protocol-api/trunk/src/java/org/apache/ incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/ incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/ClientManager.java incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/Decoder.java incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/DecoderCallback.java incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/Encoder.java incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/EncoderCallback.java incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/ProtocolProvider.java incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/RequestHandler.java incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/RequestHandlerCallback.java incubator/directory/protocol-api/trunk/src/test/ incubator/directory/protocol-api/trunk/src/test/org/ incubator/directory/protocol-api/trunk/src/test/org/apache/ incubator/directory/protocol-api/trunk/src/test/org/apache/protocol/ incubator/directory/protocol-api/trunk/src/test/org/apache/protocol/test/
Added: incubator/directory/protocol-api/trunk/INCUBATOR-DISCLAIMER.txt Url: http://svn.apache.org/viewcvs/incubator/directory/protocol-api/trunk/INCUBATOR-DISCLAIMER.txt?view=auto&rev=111818 ============================================================================== --- (empty file) +++ incubator/directory/protocol-api/trunk/INCUBATOR-DISCLAIMER.txt Tue Dec 14 06:58:42 2004 @@ -0,0 +1,17 @@ + Incubator Disclaimer + ==================== + +The Directory project is an effort undergoing incubation at the Apache Software +Foundation (ASF), sponsored by Noel Bergman. Incubation is required of all +newly accepted projects until a further review indicates that the +infrastructure, communications, and decision making process have stabilized in +a manner consistent with other successful ASF projects. While incubation +status is not necessarily a reflection of the completeness or stability of the +code, it does indicate that the project has yet to be fully endorsed by the +ASF. + +For more information about the incubation status of the Directory project you +can go to the following page: + +http://incubator.apache.org/projects/directory.html + Added: incubator/directory/protocol-api/trunk/LICENSE.txt Url: http://svn.apache.org/viewcvs/incubator/directory/protocol-api/trunk/LICENSE.txt?view=auto&rev=111818 ============================================================================== --- (empty file) +++ incubator/directory/protocol-api/trunk/LICENSE.txt Tue Dec 14 06:58:42 2004 @@ -0,0 +1,204 @@ +/* + * Apache License + * Version 2.0, January 2004 + * http://www.apache.org/licenses/ + * + * TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + * + * 1. Definitions. + * + * "License" shall mean the terms and conditions for use, reproduction, + * and distribution as defined by Sections 1 through 9 of this document. + * + * "Licensor" shall mean the copyright owner or entity authorized by + * the copyright owner that is granting the License. + * + * "Legal Entity" shall mean the union of the acting entity and all + * other entities that control, are controlled by, or are under common + * control with that entity. For the purposes of this definition, + * "control" means (i) the power, direct or indirect, to cause the + * direction or management of such entity, whether by contract or + * otherwise, or (ii) ownership of fifty percent (50%) or more of the + * outstanding shares, or (iii) beneficial ownership of such entity. + * + * "You" (or "Your") shall mean an individual or Legal Entity + * exercising permissions granted by this License. + * + * "Source" form shall mean the preferred form for making modifications, + * including but not limited to software source code, documentation + * source, and configuration files. + * + * "Object" form shall mean any form resulting from mechanical + * transformation or translation of a Source form, including but + * not limited to compiled object code, generated documentation, + * and conversions to other media types. + * + * "Work" shall mean the work of authorship, whether in Source or + * Object form, made available under the License, as indicated by a + * copyright notice that is included in or attached to the work + * (an example is provided in the Appendix below). + * + * "Derivative Works" shall mean any work, whether in Source or Object + * form, that is based on (or derived from) the Work and for which the + * editorial revisions, annotations, elaborations, or other modifications + * represent, as a whole, an original work of authorship. For the purposes + * of this License, Derivative Works shall not include works that remain + * separable from, or merely link (or bind by name) to the interfaces of, + * the Work and Derivative Works thereof. + * + * "Contribution" shall mean any work of authorship, including + * the original version of the Work and any modifications or additions + * to that Work or Derivative Works thereof, that is intentionally + * submitted to Licensor for inclusion in the Work by the copyright owner + * or by an individual or Legal Entity authorized to submit on behalf of + * the copyright owner. For the purposes of this definition, "submitted" + * means any form of electronic, verbal, or written communication sent + * to the Licensor or its representatives, including but not limited to + * communication on electronic mailing lists, source code control systems, + * and issue tracking systems that are managed by, or on behalf of, the + * Licensor for the purpose of discussing and improving the Work, but + * excluding communication that is conspicuously marked or otherwise + * designated in writing by the copyright owner as "Not a Contribution." + * + * "Contributor" shall mean Licensor and any individual or Legal Entity + * on behalf of whom a Contribution has been received by Licensor and + * subsequently incorporated within the Work. + * + * 2. Grant of Copyright License. Subject to the terms and conditions of + * this License, each Contributor hereby grants to You a perpetual, + * worldwide, non-exclusive, no-charge, royalty-free, irrevocable + * copyright license to reproduce, prepare Derivative Works of, + * publicly display, publicly perform, sublicense, and distribute the + * Work and such Derivative Works in Source or Object form. + * + * 3. Grant of Patent License. Subject to the terms and conditions of + * this License, each Contributor hereby grants to You a perpetual, + * worldwide, non-exclusive, no-charge, royalty-free, irrevocable + * (except as stated in this section) patent license to make, have made, + * use, offer to sell, sell, import, and otherwise transfer the Work, + * where such license applies only to those patent claims licensable + * by such Contributor that are necessarily infringed by their + * Contribution(s) alone or by combination of their Contribution(s) + * with the Work to which such Contribution(s) was submitted. If You + * institute patent litigation against any entity (including a + * cross-claim or counterclaim in a lawsuit) alleging that the Work + * or a Contribution incorporated within the Work constitutes direct + * or contributory patent infringement, then any patent licenses + * granted to You under this License for that Work shall terminate + * as of the date such litigation is filed. + * + * 4. Redistribution. You may reproduce and distribute copies of the + * Work or Derivative Works thereof in any medium, with or without + * modifications, and in Source or Object form, provided that You + * meet the following conditions: + * + * (a) You must give any other recipients of the Work or + * Derivative Works a copy of this License; and + * + * (b) You must cause any modified files to carry prominent notices + * stating that You changed the files; and + * + * (c) You must retain, in the Source form of any Derivative Works + * that You distribute, all copyright, patent, trademark, and + * attribution notices from the Source form of the Work, + * excluding those notices that do not pertain to any part of + * the Derivative Works; and + * + * (d) If the Work includes a "NOTICE" text file as part of its + * distribution, then any Derivative Works that You distribute must + * include a readable copy of the attribution notices contained + * within such NOTICE file, excluding those notices that do not + * pertain to any part of the Derivative Works, in at least one + * of the following places: within a NOTICE text file distributed + * as part of the Derivative Works; within the Source form or + * documentation, if provided along with the Derivative Works; or, + * within a display generated by the Derivative Works, if and + * wherever such third-party notices normally appear. The contents + * of the NOTICE file are for informational purposes only and + * do not modify the License. You may add Your own attribution + * notices within Derivative Works that You distribute, alongside + * or as an addendum to the NOTICE text from the Work, provided + * that such additional attribution notices cannot be construed + * as modifying the License. + * + * You may add Your own copyright statement to Your modifications and + * may provide additional or different license terms and conditions + * for use, reproduction, or distribution of Your modifications, or + * for any such Derivative Works as a whole, provided Your use, + * reproduction, and distribution of the Work otherwise complies with + * the conditions stated in this License. + * + * 5. Submission of Contributions. Unless You explicitly state otherwise, + * any Contribution intentionally submitted for inclusion in the Work + * by You to the Licensor shall be under the terms and conditions of + * this License, without any additional terms or conditions. + * Notwithstanding the above, nothing herein shall supersede or modify + * the terms of any separate license agreement you may have executed + * with Licensor regarding such Contributions. + * + * 6. Trademarks. This License does not grant permission to use the trade + * names, trademarks, service marks, or product names of the Licensor, + * except as required for reasonable and customary use in describing the + * origin of the Work and reproducing the content of the NOTICE file. + * + * 7. Disclaimer of Warranty. Unless required by applicable law or + * agreed to in writing, Licensor provides the Work (and each + * Contributor provides its Contributions) on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied, including, without limitation, any warranties or conditions + * of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + * PARTICULAR PURPOSE. You are solely responsible for determining the + * appropriateness of using or redistributing the Work and assume any + * risks associated with Your exercise of permissions under this License. + * + * 8. Limitation of Liability. In no event and under no legal theory, + * whether in tort (including negligence), contract, or otherwise, + * unless required by applicable law (such as deliberate and grossly + * negligent acts) or agreed to in writing, shall any Contributor be + * liable to You for damages, including any direct, indirect, special, + * incidental, or consequential damages of any character arising as a + * result of this License or out of the use or inability to use the + * Work (including but not limited to damages for loss of goodwill, + * work stoppage, computer failure or malfunction, or any and all + * other commercial damages or losses), even if such Contributor + * has been advised of the possibility of such damages. + * + * 9. Accepting Warranty or Additional Liability. While redistributing + * the Work or Derivative Works thereof, You may choose to offer, + * and charge a fee for, acceptance of support, warranty, indemnity, + * or other liability obligations and/or rights consistent with this + * License. However, in accepting such obligations, You may act only + * on Your own behalf and on Your sole responsibility, not on behalf + * of any other Contributor, and only if You agree to indemnify, + * defend, and hold each Contributor harmless for any liability + * incurred by, or claims asserted against, such Contributor by reason + * of your accepting any such warranty or additional liability. + * + * END OF TERMS AND CONDITIONS + * + * APPENDIX: How to apply the Apache License to your work. + * + * To apply the Apache License to your work, attach the following + * boilerplate notice, with the fields enclosed by brackets "[]" + * replaced with your own identifying information. (Don't include + * the brackets!) The text should be enclosed in the appropriate + * comment syntax for the file format. We also recommend that a + * file or class name and description of purpose be included on the + * same "printed page" as the copyright notice for easier + * identification within third-party archives. + * + * Copyright [yyyy] [name of copyright owner] + * + * 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. + * + */ Added: incubator/directory/protocol-api/trunk/NOTICE.txt Url: http://svn.apache.org/viewcvs/incubator/directory/protocol-api/trunk/NOTICE.txt?view=auto&rev=111818 ============================================================================== --- (empty file) +++ incubator/directory/protocol-api/trunk/NOTICE.txt Tue Dec 14 06:58:42 2004 @@ -0,0 +1,4 @@ +This product includes software developed by +The Apache Software Foundation (http://www.apache.org/). + + Added: incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/ClientManager.java Url: http://svn.apache.org/viewcvs/incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/ClientManager.java?view=auto&rev=111818 ============================================================================== --- (empty file) +++ incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/ClientManager.java Tue Dec 14 06:58:42 2004 @@ -0,0 +1,62 @@ +/* + * Copyright 2004 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.protocol; + +import java.net.Socket; +import java.net.SocketAddress; + +/** + * The ClientManager provides a mechanism for the ProtocolProvider to + * send control events to the network library. This is not a mandatory + * piece of functionality, and the network library may choose not to + * support it, or to only partially support it. It is imperative that + * the network library does not put itself in an unstable state by + * responding to these requests. + */ +public interface ClientManager +{ + /** + * This event is called if the protocol controls when connections + * are to be disconnected. It helps the network library to + * intelligently clean up resources in a timely manner. + * + * @param client The client to disconnect + */ + void disconnectClient(Socket client); + + /** + * The particular client is behaving badly, so the protocol provider + * is asking the networking library to ban a client either temporarily + * or permanently. It is up to the network library to decide how long + * a temporary ban would be. If the client is connected, it will be + * disconnected. + * + * @param client The client to ban + * @param permanently Whether the ban is permanent or temporary + */ + void banClient(SocketAddress client, boolean permanently); + + /** + * A particular client is no longer behaving badly, and the protocol + * is responding to a management request to allow a client to connect + * again. Regardless of whether the ban was temporary or permanent, + * this event reenables the client to connect. + * + * @param client the client to reallow + */ + void unbanClient(SocketAddress client); +} Added: incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/Decoder.java Url: http://svn.apache.org/viewcvs/incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/Decoder.java?view=auto&rev=111818 ============================================================================== --- (empty file) +++ incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/Decoder.java Tue Dec 14 06:58:42 2004 @@ -0,0 +1,39 @@ +/* + * Copyright 2004 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.protocol; + +import java.nio.ByteBuffer; + +/** + * The Decoder interface provides a place to send the ByteBuffers read + * from a stream and generate requests. The individual Decoder object + * returned remembers where the destination (the DecoderCallback) is + * from, and is considered specific to a client. For stateless protocols, + * this is unnecessary--but the network layers assume that there is a + * connection--making it possible to write stateful decoders. + */ +public interface Decoder +{ + /** + * Decode a ByteBuffer into individual request objects. If a + * request spans multiple buffers, the decoder will temporarily hold + * the information it needs until the rest of the request comes in. + * + * @param buffer the current snapshot of information being read. + */ + void decode(ByteBuffer buffer); +} Added: incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/DecoderCallback.java Url: http://svn.apache.org/viewcvs/incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/DecoderCallback.java?view=auto&rev=111818 ============================================================================== --- (empty file) +++ incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/DecoderCallback.java Tue Dec 14 06:58:42 2004 @@ -0,0 +1,39 @@ +/* + * Copyright 2004 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.protocol; + +import java.net.Socket; + +/** + * The DecoderCallback handles individual requests as they are completely + * decoded by the Decoder. It is the responsibility of the network + * library writer to implement this interface so that it can forward + * the request on to the RequestHandler and track things accordingly. + */ +public interface DecoderCallback +{ + /** + * Each time a request is decoded, this method is called with the + * client info and the request object. The request is protocol + * specific, so it is up to the protocol provider to ensure that the + * objects received make sense for the protocol. + * + * @param client the socket client we are interacting with + * @param request the request object we are forwarding on + */ + void decoded(Socket client, Object request); +} Added: incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/Encoder.java Url: http://svn.apache.org/viewcvs/incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/Encoder.java?view=auto&rev=111818 ============================================================================== --- (empty file) +++ incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/Encoder.java Tue Dec 14 06:58:42 2004 @@ -0,0 +1,39 @@ +/* + * Copyright 2004 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.protocol; + +/** + * The Encoder interface provides a place to send the ByteBuffers to + * write to a stream from generated responses. The individual Encoder + * objects returned remembers where the destination (the + * EncoderCallback) is from, and is considered specific to a client. + * For stateless protocols, this is unnecessary--but the network layers + * assume that there is a connection--making it possible to write + * stateful encoders. + */ +public interface Encoder +{ + /** + * Encode a response object into one or more ByteBuffers to send + * to the client. This approach provides the ability to take large + * responses, or multipart responses and send them piecemeal as + * the response is done being processed. + * + * @param response the response object to encode. + */ + void encode(Object response); +} Added: incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/EncoderCallback.java Url: http://svn.apache.org/viewcvs/incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/EncoderCallback.java?view=auto&rev=111818 ============================================================================== --- (empty file) +++ incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/EncoderCallback.java Tue Dec 14 06:58:42 2004 @@ -0,0 +1,36 @@ +/* + * Copyright 2004 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.protocol; + +import java.net.Socket; +import java.nio.ByteBuffer; + +/** + * Sends the encoded ByteBuffer to the network library along with the client + * being responded to. The network library is responsible for implementing + * this interface to provide the proper way to seal the deal. + */ +public interface EncoderCallback +{ + /** + * The encoded response to serialize to the client. + * + * @param client The socket representing a client. + * @param buffer The encoded response. + */ + void encoded(Socket client, ByteBuffer buffer); +} Added: incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/ProtocolProvider.java Url: http://svn.apache.org/viewcvs/incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/ProtocolProvider.java?view=auto&rev=111818 ============================================================================== --- (empty file) +++ incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/ProtocolProvider.java Tue Dec 14 06:58:42 2004 @@ -0,0 +1,79 @@ +/* + * Copyright 2004 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.protocol; + +import java.net.Socket; + +/** + * The ProtocolProvider is how asyncronous networking libraries will + * interact with a particular type of API. The provider will provide + * a way to decode ByteBuffers of information, turn it into requests + * (which are protocol specific) and encode the responses (again which + * are protocol specific) back to ByteBuffers which can be then + * serialized to the client. + * <p> + * The ProtocolProvider is written in such a manner as to not care + * whether the protocol is stateful or not--but still enable stateful + * protocols. + */ +public interface ProtocolProvider +{ + /** + * Get the Decoder for the supplied client, that will call the + * callback supplied. + * + * @param client The client we are decoding. + * @param destination The destination to send request objects. + * + * @return the particular Decoder we need. + */ + Decoder getDecoder(Socket client, DecoderCallback destination); + + /** + * Get the request handler that forwards requests on to the + * RequestHandlerCallback. It is assumed that there will be only + * one RequestHandler no matter haw many clients are being managed. + * + * @param destination the callback to send responses to. + * + * @return the RequestHandler for this protocol. + */ + RequestHandler getRequestHandler(RequestHandlerCallback destination); + + /** + * Get the Encoder for the supplied client, that will call the + * callback supplied. + * + * @param client The client we are encoding. + * @param destination The destination to send ByteBuffers. + * + * @return the particular Encoder we need. + */ + Encoder getEncoder(Socket client, EncoderCallback destination); + + /** + * This is a hook that a network library can provide to allow protocol + * specific management of clients. If the client manager is not + * supplied by the network library, the ProtocolProvider must function + * as best it can without that support. However, if the library + * does provide the manager, it opens up a wider range of functionality + * for the ProtocolProvider. + * + * @param manager the ClientManager provided by the network library. + */ + void setClientManager(ClientManager manager); +} Added: incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/RequestHandler.java Url: http://svn.apache.org/viewcvs/incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/RequestHandler.java?view=auto&rev=111818 ============================================================================== --- (empty file) +++ incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/RequestHandler.java Tue Dec 14 06:58:42 2004 @@ -0,0 +1,39 @@ +/* + * Copyright 2004 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.protocol; + +import java.net.Socket; + +/** + * The RequestHandler responds to request objects (see [EMAIL PROTECTED] Decoder}), + * and then forwards the responses on to the RequestHandlerCallback as + * they are completed. It is assumed that requests are stateless, and + * that one handler can handle them all. + * <p> + * NOTE: if this is not the case, we will alter the design accordingly. + */ +public interface RequestHandler +{ + /** + * Handle the request that was last decoded. The response will be + * forwarded on to the supplied callback. + * + * @param client The client associated with this request. + * @param request The request object + */ + void handleRequest(Socket client, Object request); +} Added: incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/RequestHandlerCallback.java Url: http://svn.apache.org/viewcvs/incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/RequestHandlerCallback.java?view=auto&rev=111818 ============================================================================== --- (empty file) +++ incubator/directory/protocol-api/trunk/src/java/org/apache/protocol/RequestHandlerCallback.java Tue Dec 14 06:58:42 2004 @@ -0,0 +1,37 @@ +/* + * Copyright 2004 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.protocol; + +import java.net.Socket; + +/** + * The RequestHandlerCallback is implemented by the network library, but + * it is the target for all responses that will be encoded and sent back + * to the client. + */ +public interface RequestHandlerCallback +{ + /** + * Handle the response from a request from a client. The network + * library will forward this response on to the encoder to send back + * to the client. + * + * @param client The client associated with the response. + * @param response The response object (protocol specific). + */ + void requestHandled(Socket client, Object response); +}
