com.helger.photon.api.APIDescriptor Maven / Gradle / Ivy
The newest version!
/*
* Copyright (C) 2014-2024 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* 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 com.helger.photon.api;
import java.util.function.Supplier;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.collection.CollectionHelper;
import com.helger.commons.collection.impl.CommonsLinkedHashSet;
import com.helger.commons.collection.impl.ICommonsOrderedSet;
import com.helger.commons.factory.FactoryNewInstance;
import com.helger.commons.string.StringHelper;
import com.helger.commons.string.ToStringGenerator;
import com.helger.photon.api.pathdescriptor.PathDescriptor;
/**
* Default implementation of {@link IAPIDescriptor}.
*
* @author Philip Helger
*/
@NotThreadSafe
public class APIDescriptor implements IAPIDescriptor
{
private final APIPath m_aAPIPath;
// The path descriptor is automatically build from the APIPath
private final PathDescriptor m_aPathDescriptor;
private final Supplier m_aExecutorFactory;
private final ICommonsOrderedSet m_aRequiredHeaders = new CommonsLinkedHashSet <> ();
private final ICommonsOrderedSet m_aRequiredParams = new CommonsLinkedHashSet <> ();
private final ICommonsOrderedSet m_aAllowedMimeTypes = new CommonsLinkedHashSet <> ();
private IAPIExecutionFilter m_aExecutionFilter;
private IAPIExceptionMapper m_aExceptionMapper;
/**
* Constructor
*
* @param aPath
* API Path to be used. May not be null.
* @param aExecutor
* The executor to be invoked for that API. May not be
* null.
*/
public APIDescriptor (@Nonnull final APIPath aPath, @Nonnull final IAPIExecutor aExecutor)
{
this (aPath, () -> aExecutor);
}
/**
* Constructor
*
* @param aPath
* API Path to be used. May not be null.
* @param aExecutorClass
* The executor class to be instantiated for every API invocation. May
* not be null.
*/
public APIDescriptor (@Nonnull final APIPath aPath, @Nonnull final Class aExecutorClass)
{
this (aPath, FactoryNewInstance.create (aExecutorClass));
}
/**
* Constructor
*
* @param aPath
* API Path to be used. May not be null.
* @param aExecutorFactory
* The factory to be used to create executor instances for every API
* invocation. May not be null.
*/
public APIDescriptor (@Nonnull final APIPath aPath, @Nonnull final Supplier aExecutorFactory)
{
m_aAPIPath = ValueEnforcer.notNull (aPath, "Path");
m_aPathDescriptor = PathDescriptor.create (aPath.getPath ());
m_aExecutorFactory = ValueEnforcer.notNull (aExecutorFactory, "ExecutorFactory");
}
@Nonnull
public final APIPath getAPIPath ()
{
return m_aAPIPath;
}
@Nonnull
public final PathDescriptor getPathDescriptor ()
{
return m_aPathDescriptor;
}
@Nonnull
public final Supplier getExecutorFactory ()
{
return m_aExecutorFactory;
}
/**
* Add a required HTTP header. If this HTTP header is not present, invocation
* will not be possible.
*
* @param sHeaderName
* The name of the required HTTP header. May be null or
* empty in which case the header is ignored.
* @return this for chaining
* @see #addRequiredHeaders(String...)
*/
@Nonnull
public final APIDescriptor addRequiredHeader (@Nullable final String sHeaderName)
{
if (StringHelper.hasText (sHeaderName))
m_aRequiredHeaders.add (sHeaderName);
return this;
}
/**
* Add one or more required HTTP headers. If one of these HTTP headers are not
* present, invocation will not be possible.
*
* @param aHeaderNames
* The names of the required HTTP headers. May be null or
* empty.
* @return this for chaining
* @see #addRequiredHeader(String)
*/
@Nonnull
public final APIDescriptor addRequiredHeaders (@Nullable final String... aHeaderNames)
{
if (aHeaderNames != null)
for (final String sHeaderName : aHeaderNames)
addRequiredHeader (sHeaderName);
return this;
}
@Nonnull
@ReturnsMutableObject
public final ICommonsOrderedSet requiredHeaders ()
{
return m_aRequiredHeaders;
}
/**
* Add a required request parameter. If this request parameter is not present,
* invocation will not be possible.
*
* @param sParamName
* The name of the required request parameter. May be null
* or empty in which case the parameter is ignored.
* @return this for chaining
* @see #addRequiredParams(String...)
*/
@Nonnull
public final APIDescriptor addRequiredParam (@Nullable final String sParamName)
{
if (StringHelper.hasText (sParamName))
m_aRequiredParams.add (sParamName);
return this;
}
/**
* Add one or more required request parameters. If one of these request
* parameters are not present, invocation will not be possible.
*
* @param aParamNames
* The names of the required HTTP parameters. May be null
* or empty.
* @return this for chaining
* @see #addRequiredParam(String)
*/
@Nonnull
public final APIDescriptor addRequiredParams (@Nullable final String... aParamNames)
{
if (aParamNames != null)
for (final String sParamName : aParamNames)
addRequiredParam (sParamName);
return this;
}
@Nonnull
@ReturnsMutableObject
public final ICommonsOrderedSet requiredParams ()
{
return m_aRequiredParams;
}
@Nonnull
@ReturnsMutableObject
public final ICommonsOrderedSet allowedMimeTypes ()
{
return m_aAllowedMimeTypes;
}
@Nullable
public final IAPIExecutionFilter getExecutionFilter ()
{
return m_aExecutionFilter;
}
@Nonnull
public final APIDescriptor setExecutionFilter (@Nullable final IAPIExecutionFilter aExecutionFilter)
{
m_aExecutionFilter = aExecutionFilter;
return this;
}
@Nullable
public final IAPIExceptionMapper getExceptionMapper ()
{
return m_aExceptionMapper;
}
@Nonnull
public final APIDescriptor setExceptionMapper (@Nullable final IAPIExceptionMapper aExceptionMapper)
{
m_aExceptionMapper = aExceptionMapper;
return this;
}
@Override
public String toString ()
{
return new ToStringGenerator (null).append ("APIPath", m_aAPIPath)
.append ("PathDescriptor", m_aPathDescriptor)
.append ("ExecutionFactory", m_aExecutorFactory)
.appendIf ("RequiredHeaders", m_aRequiredHeaders, CollectionHelper::isNotEmpty)
.appendIf ("RequiredParams", m_aRequiredParams, CollectionHelper::isNotEmpty)
.appendIf ("AllowedMimeTypes", m_aAllowedMimeTypes, CollectionHelper::isNotEmpty)
.appendIfNotNull ("ExecutionFilter", m_aExecutionFilter)
.appendIfNotNull ("ExceptionMapper", m_aExceptionMapper)
.getToString ();
}
}