001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019package org.apache.isis.viewer.restfulobjects.applib.homepage;
020
021import javax.ws.rs.*;
022import javax.ws.rs.core.MediaType;
023import javax.ws.rs.core.Response;
024
025import org.apache.isis.viewer.restfulobjects.applib.RestfulMediaType;
026import org.jboss.resteasy.annotations.ClientResponseType;
027
028@Path("/")
029public interface HomePageResource {
030
031    @GET
032    @Produces({ MediaType.APPLICATION_JSON, RestfulMediaType.APPLICATION_JSON_HOME_PAGE })
033    @ClientResponseType(entityType = String.class)
034    public Response homePage();
035
036    @DELETE
037    public Response deleteHomePageNotAllowed();
038
039    @PUT
040    public Response putHomePageNotAllowed();
041
042    @POST
043    public Response postHomePageNotAllowed();
044
045    /**
046     * Not part of the RO spec; this resource always returns 401, and is
047     * intended to be redirected to if credentials cannot be obtained.
048     */
049    @GET
050    @Path("/notAuthenticated")
051    @Produces({ MediaType.APPLICATION_JSON })
052    @ClientResponseType(entityType = String.class)
053    public Response notAuthenticated();
054
055}