= AcceptHeaderService
:Notice: 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.

This service simply exposes the HTTP `Accept` header to the domain.

Its intended use is to support multiple versions of a REST API, where the responsibility for content negotiation (determining which version of the REST API is to be used) is managed by logic in the domain objects themselves.

== API

[source,java]
.AcceptHeaderService.java
----
interface AcceptHeaderService {
  List<MediaType> getAcceptableMediaTypes()     // <.>
}
----

<.> xref:#getAcceptableMediaTypes_[getAcceptableMediaTypes()]
+
--
The intention is that this service only returns a list when the request is initiated through the _Restful Objects viewer_.
--

== Members

[#getAcceptableMediaTypes_]
=== getAcceptableMediaTypes()

The intention is that this service only returns a list when the request is initiated through the _Restful Objects viewer_.

Otherwise the service will likely return `null`.

include::hooks/AcceptHeaderService_010-implementation.adoc[]

include::hooks/AcceptHeaderService_020-examples-and-usage.adoc[]
