1 /*
2 * Copyright (c) 2007, Fraunhofer-Gesellschaft
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * (1) Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the disclaimer at the end.
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
14 * distribution.
15 *
16 * (2) Neither the name of Fraunhofer nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * DISCLAIMER
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 */
35 package org.ogf.graap.wsag.client.api;
36
37 import org.ogf.graap.wsag.api.exceptions.ResourceUnavailableException;
38 import org.ogf.graap.wsag.api.exceptions.ResourceUnknownException;
39
40 /**
41 * Client to an agreement factory registry. The registry is used to query a list of agreement factory clients
42 * that is hosted on a WSAG4J server.
43 *
44 * @author Oliver Waeldrich
45 */
46 public interface AgreementFactoryRegistryClient
47 {
48 /**
49 * Default registry builder.
50 */
51 ClientLocator<AgreementFactoryRegistryClient> FACTORY =
52 new ClientLocator<AgreementFactoryRegistryClient>( AgreementFactoryRegistryClient.class );
53
54 /**
55 * Lists all agreement factories at the given endpoint.
56 *
57 * @return a set of {@link AgreementFactoryClient} available at the given endpoint
58 *
59 * @throws ResourceUnknownException
60 * the remote resource is unknown
61 * @throws ResourceUnavailableException
62 * the remote resource is unavailable
63 */
64 AgreementFactoryClient[] listAgreementFactories()
65 throws ResourceUnknownException, ResourceUnavailableException;
66
67 /**
68 * Returns an {@link AgreementFactoryClient} for the factory with the given resource id or null if no
69 * factory with that resource id exists.
70 *
71 * @param resourceId
72 * the factory resource id
73 *
74 * @return the agreement factory client for the requested resource id or null if no factory with the given
75 * id exists
76 *
77 * @throws ResourceUnknownException
78 * the remote resource is unknown
79 * @throws ResourceUnavailableException
80 * the remote resource is unavailable
81 */
82 AgreementFactoryClient getFactory( String resourceId )
83 throws ResourceUnknownException, ResourceUnavailableException;
84 }