org.xlcloud.rest.RequestAwareResource Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 AMG.lab, a Bull Group Company
 * 
 * Licensed 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.xlcloud.rest;

import java.util.List;

/**
 * Interface for the resources api classes.
 * @author Konrad Król, AMG.net
 */
public interface RequestAwareResource {

    /**
     * Returns the relative request path used for entitlement validation.
     * @return the relative request path
     */
    String getRelativeRequestPath();

    /**
     * Returns the http method used for entitlement validation
     * @return the http method
     */
    String getHttpMethod();

    /**
     * Returns the normalized path for the resource.
     * Normalized paths contains ids of the nested resources.
     * @return the normalized path.
     */
    String normalizePath();
    
    Long getAccountId();
    
    /**
     * 
     * Returns the header values for the specified keys.
     * @param headerName header key
     * @return header value
     */
    List getHeaderValuesForName(String headerName);

}