View Javadoc

1   /**
2    * Copyright 2005-2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.ksb.messaging.remotedservices;
17  
18  import javax.ws.rs.Consumes;
19  import javax.ws.rs.DELETE;
20  import javax.ws.rs.GET;
21  import javax.ws.rs.POST;
22  import javax.ws.rs.PUT;
23  import javax.ws.rs.Path;
24  import javax.ws.rs.PathParam;
25  import javax.ws.rs.Produces;
26  
27  /**
28   * RESTful service interface for an inbox
29   *
30   * @author Kuali Rice Team (rice.collab@kuali.org)
31   *
32   */
33  @Path("inbox")
34  public interface InboxResource {
35  
36  	@POST
37  	@Produces("application/xml")
38  	@Consumes("application/xml")
39  	public Inbox createInbox(Inbox inbox);
40  
41  	@GET
42  	@Path("{id}")
43  	@Produces("application/xml")
44  	public Inbox retrieveInbox(@PathParam("id") String id);
45  
46  	@PUT
47  	@Consumes("application/xml")
48  	public void updateInbox(Inbox inbox);
49  
50  	@DELETE
51  	public void deleteInbox(@PathParam("id") String id);
52  
53  
54  	public MessageResource getMessageResource();
55  
56  }