1 /**
2 * Copyright (C) 2005-2009 Alfresco Software Limited.
3 *
4 * This file is part of the Spring Surf Extension project.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * 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, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 package org.springframework.extensions.webscripts.connector;
20
21 import java.net.URL;
22
23 /**
24 * Interface for Client implementations
25 *
26 * This interface is pretty lightweight at the moment. The Client implementation
27 * requirements are deliberately so since we're still feeling out what kind of
28 * custom Clients might be written in the future.
29 *
30 * At present, it seems that most things are solved by the root RemoteClient
31 * object.
32 *
33 * This interface is therefore subject to change in the future.
34 *
35 * Developers seeking to write their own Clients are encouraged to extend the
36 * AbstractClient base class.
37 *
38 * @author muzquiano
39 */
40 public interface Client
41 {
42 /**
43 * @return the Endpoint for this Client e.g.
44 * http://localhost:8080/alfresco/service
45 */
46 public String getEndpoint();
47
48 /**
49 * @return the Endpoint for the Client as a URL object
50 */
51 public URL getURL();
52 }