lib/server-api/src/main/java/org/apache/olingo/server/api/etag/ServiceMetadataETagSupport.java

/*
 * 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.olingo.server.api.etag;

/**
 * Register implementations for this interface in oder to support etags for the metadata document and service document.
 */
public interface ServiceMetadataETagSupport {

  /**
   * Since the Olingo library cannot generate a metadata document etag in a generic way we call this method to retrieve
   * an application specific etag for the metadata document. If this interface is registered applications can return an
   * etag or null here to provide caching support for clients. If a client sends a GET request to the metadata document
   * and this method delivers an etag we will match it to the request. If there has been no modification we will return
   * a 304 NOT MODIFIED status code. If this interface is not registered or delivers null we just send back the usual
   * metadata response.
   * @return the application generated etag for the metadata document
   */
  String getMetadataETag();

  /**
   * Since the Olingo library cannot generate a service document etag in a generic way we call this method to retrieve
   * an application specific etag for the service document. If this interface is registered applications can return an
   * etag or null here to provide caching support for clients. If a client sends a GET request to the service document
   * and this method delivers an etag we will match it to the request. If there has been no modification we will return
   * a 304 NOT MODIFIED status code. If this interface is not registered or delivers null we just send back the usual
   * service document response.
   * @return the application generated etag for the service document
   */
  String getServiceDocumentETag();

}