This repository has been archived by the owner on Aug 11, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
ServiceDefinitionModule.java
67 lines (57 loc) · 2.32 KB
/
ServiceDefinitionModule.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*******************************************************************************
* Copyright (c) 2010-2011 Sonatype, Inc.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
* The Apache License v2.0 is available at
* http://www.apache.org/licenses/LICENSE-2.0.html
* You may elect to redistribute this code under either of these licenses.
*******************************************************************************/
package org.sonatype.restsimple.spi;
import com.google.inject.Injector;
import org.sonatype.restsimple.api.ServiceDefinition;
import java.util.List;
/**
* A simple interface allowing applications to define a list of {@link ServiceDefinition} to deploy, and configure
* the server side functionality.
*/
public interface ServiceDefinitionModule {
/**
* Return the a list of ServiceDefinition to generate. By default this method scan the classpath in search
* for class annotated with the @Service annotation, and search for method that returns an instance of {@link ServiceDefinition}
*
* @param injector a Guice {@link Injector}
* @return the a list of ServiceDefinition to generate.
*/
List<ServiceDefinition> defineServices(Injector injector);
/**
* Configure the {@link NegotiationTokenGenerator} used for content/version negotiation.
* @return an instance of {@link NegotiationTokenGenerator}
*/
NegotiationTokenGenerator configureNegotiationTokenGenerator();
/**
* Return the {@link Injector} used to create the module
* @return the {@link Injector} used to create the module
*/
Injector injector();
/**
* Scan for native REST resource located in the package name
*
* @param packageName the package name
*/
ServiceDefinitionModule scan(Package packageName);
/**
* Add a Rest resource.
*
* @param className the class name
*/
ServiceDefinitionModule addClass(Class<?> className);
/**
* Add a Rest resource.
*
* @param instance the class name
*/
ServiceDefinitionModule addInstance(ServiceDefinition instance);
}