org.apache.wink.common.DynamicResource Maven / Gradle / Ivy
/*******************************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*******************************************************************************/
package org.apache.wink.common;
import org.apache.wink.common.annotations.Parent;
/**
* This interface replaces Path annotation to declare a resource. It's
* impossible to declare resource using both DynamicResource interface and Path
* annotation.
*
* In general it's recommended to extend from AbstractDynamicResource, instead
* of implementing the DynamicResource.
*
* @see org.apache.wink.common.AbstractDynamicResource
* @see javax.ws.rs.Path
*/
public interface DynamicResource {
/**
* returns the name of the bean The bean name must be unique and usually
* should come from Spring. If your bean is not generated by Spring, return
* null and the unique bean name will be generated. If method bean name was
* set using the setBeanName method, the method must return the same name
* that was set.
*
* @return
*/
String getBeanName();
/**
* sets bean name. After this method was invoked, the getBeanName() must
* return the same method that was set.
*
* @param beanName
*/
void setBeanName(String beanName);
/**
* Returns path. Similar to value() of javax.ws.rs.Path
*
* @return path of the resource
*/
String getPath();
/**
*
* A parent of this resource, so the resulting path is a composition of the
* parent's path and this one.
*
* Note that in comparison to the Parent annotation, the parent here must be
* reference to the resource and not class.
*
* If method setParent was invoked, this method must return the same parent
* that was set.
*
* @return Resource instance of the parent dispatched URIs
* @see Parent
*/
Object getParent();
/**
*
* Sets parents. See getParent() for full description.
*
* @param parents
*/
void setParent(Object parents);
/**
* Returns the workspace title. If the title was already defined using
* Workspace, the annotation data is overridden.
*
* @return workspace title
* @see org.apache.wink.common.annotations.Workspace
*/
String getWorkspaceTitle();
/**
* Returns the collection title. If the title was already defined using
* Workspace, the annotation data is overridden.
*
* @return collection title
* @see org.apache.wink.common.annotations.Workspace
*/
String getCollectionTitle();
}