eu.toop.edm.EDMErrorResponse Maven / Gradle / Ivy
The newest version!
/**
* This work is protected under copyrights held by the members of the
* TOOP Project Consortium as indicated at
* http://wiki.ds.unipi.gr/display/TOOP/Contributors
* (c) 2018-2021. All rights reserved.
*
* This work is dual licensed under Apache License, Version 2.0
* and the EUPL 1.2.
*
* = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
*
* 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.
*
* = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
*
* Licensed under the EUPL, Version 1.2 or – as soon they will be approved
* by the European Commission - subsequent versions of the EUPL
* (the "Licence");
* You may not use this work except in compliance with the Licence.
* You may obtain a copy of the Licence at:
*
* https://joinup.ec.europa.eu/software/page/eupl
*/
package eu.toop.edm;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Function;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.w3c.dom.Node;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.CommonsArrayList;
import com.helger.commons.collection.impl.CommonsLinkedHashMap;
import com.helger.commons.collection.impl.CommonsLinkedHashSet;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.collection.impl.ICommonsOrderedMap;
import com.helger.commons.collection.impl.ICommonsOrderedSet;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.StringHelper;
import com.helger.commons.string.ToStringGenerator;
import eu.toop.edm.error.EDMExceptionPojo;
import eu.toop.edm.jaxb.cv.agent.AgentType;
import eu.toop.edm.model.AgentPojo;
import eu.toop.edm.slot.SlotErrorProvider;
import eu.toop.edm.slot.SlotSpecificationIdentifier;
import eu.toop.edm.xml.IJAXBVersatileReader;
import eu.toop.edm.xml.IVersatileWriter;
import eu.toop.edm.xml.JAXBVersatileReader;
import eu.toop.edm.xml.JAXBVersatileWriter;
import eu.toop.edm.xml.cagv.AgentMarshaller;
import eu.toop.edm.xml.cccev.CCCEV;
import eu.toop.regrep.ERegRepResponseStatus;
import eu.toop.regrep.RegRep4Reader;
import eu.toop.regrep.RegRep4Writer;
import eu.toop.regrep.RegRepHelper;
import eu.toop.regrep.query.QueryResponse;
import eu.toop.regrep.rim.AnyValueType;
import eu.toop.regrep.rim.SlotType;
import eu.toop.regrep.rim.StringValueType;
import eu.toop.regrep.rim.ValueType;
import eu.toop.regrep.rs.RegistryExceptionType;
import eu.toop.regrep.slot.ISlotProvider;
/**
* A simple builder to create valid TOOP Error responses for both "concept
* queries" and for "document queries". See {@link #builder()}.
*
* @author Philip Helger
*/
public class EDMErrorResponse implements IEDMTopLevelObject
{
private static final ICommonsOrderedSet TOP_LEVEL_SLOTS = new CommonsLinkedHashSet <> (SlotSpecificationIdentifier.NAME,
SlotErrorProvider.NAME);
private final ERegRepResponseStatus m_eResponseStatus;
private final String m_sRequestID;
private final String m_sSpecificationIdentifier;
private final AgentPojo m_aErrorProvider;
private final ICommonsList m_aExceptions = new CommonsArrayList <> ();
protected EDMErrorResponse (@Nonnull final ERegRepResponseStatus eResponseStatus,
@Nonnull @Nonempty final String sRequestID,
@Nonnull @Nonempty final String sSpecificationIdentifier,
@Nullable final AgentPojo aErrorProvider,
@Nonnull @Nonempty final ICommonsList aExceptions)
{
ValueEnforcer.notNull (eResponseStatus, "ResponseStatus");
ValueEnforcer.isTrue (eResponseStatus == ERegRepResponseStatus.SUCCESS || eResponseStatus == ERegRepResponseStatus.FAILURE,
"Only SUCCESS and FAILURE are supported");
ValueEnforcer.notEmpty (sRequestID, "RequestID");
ValueEnforcer.notEmpty (sSpecificationIdentifier, "SpecificationIdentifier");
ValueEnforcer.notEmptyNoNullValue (aExceptions, "Exceptions");
m_eResponseStatus = eResponseStatus;
m_sRequestID = sRequestID;
m_sSpecificationIdentifier = sSpecificationIdentifier;
m_aErrorProvider = aErrorProvider;
m_aExceptions.addAll (aExceptions);
}
@Nonnull
public final ERegRepResponseStatus getResponseStatus ()
{
return m_eResponseStatus;
}
@Nonnull
@Nonempty
public final String getRequestID ()
{
return m_sRequestID;
}
@Nonnull
@Nonempty
public final String getSpecificationIdentifier ()
{
return m_sSpecificationIdentifier;
}
@Nullable
public final AgentPojo getErrorProvider ()
{
return m_aErrorProvider;
}
@Nonnull
@Nonempty
public final List exceptions ()
{
return m_aExceptions;
}
@Nonnull
@Nonempty
@ReturnsMutableCopy
public final List getAllExceptions ()
{
return m_aExceptions.getClone ();
}
@Nonnull
private QueryResponse _createQueryResponse (@Nonnull final ICommonsList aProviders)
{
final ICommonsOrderedMap aProviderMap = new CommonsLinkedHashMap <> ();
for (final ISlotProvider aItem : aProviders)
{
final String sName = aItem.getName ();
if (aProviderMap.containsKey (sName))
throw new IllegalArgumentException ("A slot provider for name '" + sName + "' is already present");
aProviderMap.put (sName, aItem);
}
final QueryResponse ret = RegRepHelper.createEmptyQueryResponse (m_eResponseStatus);
ret.setRequestId (m_sRequestID);
// All top-level slots outside of object list
for (final String sHeader : TOP_LEVEL_SLOTS)
{
final ISlotProvider aSP = aProviderMap.get (sHeader);
if (aSP != null)
ret.addSlot (aSP.createSlot ());
}
for (final EDMExceptionPojo aItem : m_aExceptions)
ret.addException (aItem.getAsRegistryException ());
return ret;
}
@Nonnull
public QueryResponse getAsErrorResponse ()
{
final ICommonsList aSlots = new CommonsArrayList <> ();
if (m_sSpecificationIdentifier != null)
aSlots.add (new SlotSpecificationIdentifier (m_sSpecificationIdentifier));
if (m_aErrorProvider != null)
aSlots.add (new SlotErrorProvider (m_aErrorProvider));
// Exceptions
return _createQueryResponse (aSlots);
}
@Nonnull
public IVersatileWriter getWriter ()
{
return new JAXBVersatileWriter <> (getAsErrorResponse (), RegRep4Writer.queryResponse (CCCEV.XSDS).setFormattedOutput (true));
}
@Nonnull
public static IJAXBVersatileReader reader ()
{
return new JAXBVersatileReader <> (RegRep4Reader.queryResponse (CCCEV.XSDS), EDMErrorResponse::create);
}
@Override
public boolean equals (final Object o)
{
if (o == this)
return true;
if (o == null || getClass () != o.getClass ())
return false;
final EDMErrorResponse that = (EDMErrorResponse) o;
return EqualsHelper.equals (m_eResponseStatus, that.m_eResponseStatus) &&
EqualsHelper.equals (m_sRequestID, that.m_sRequestID) &&
EqualsHelper.equals (m_sSpecificationIdentifier, that.m_sSpecificationIdentifier) &&
EqualsHelper.equals (m_aErrorProvider, that.m_aErrorProvider) &&
EqualsHelper.equals (m_aExceptions, that.m_aExceptions);
}
@Override
public int hashCode ()
{
return new HashCodeGenerator (this).append (m_eResponseStatus)
.append (m_sRequestID)
.append (m_sSpecificationIdentifier)
.append (m_aErrorProvider)
.append (m_aExceptions)
.getHashCode ();
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("RequestID", m_sRequestID)
.append ("ResponseStatus", m_eResponseStatus)
.append ("SpecificationIdentifier", m_sSpecificationIdentifier)
.append ("ErrorProvider", m_aErrorProvider)
.append ("Exceptions", m_aExceptions)
.getToString ();
}
@Nonnull
public static Builder builder ()
{
// Use the default specification identifier
// Failure by default
return new Builder ().specificationIdentifier (CToopEDM.SPECIFICATION_IDENTIFIER_TOOP_EDM_V21)
.responseStatus (ERegRepResponseStatus.FAILURE);
}
public static class Builder
{
private ERegRepResponseStatus m_eResponseStatus;
private String m_sRequestID;
private String m_sSpecificationIdentifier;
private AgentPojo m_aErrorProvider;
private final ICommonsList m_aExceptions = new CommonsArrayList <> ();
public Builder ()
{}
@Nonnull
public Builder responseStatus (@Nullable final ERegRepResponseStatus e)
{
m_eResponseStatus = e;
return this;
}
@Nonnull
public Builder requestID (@Nullable final String s)
{
m_sRequestID = s;
return this;
}
@Nonnull
public Builder specificationIdentifier (@Nullable final String s)
{
m_sSpecificationIdentifier = s;
return this;
}
@Nonnull
public final Builder errorProvider (@Nullable final Consumer a)
{
if (a != null)
{
final AgentPojo.Builder aBuilder = AgentPojo.builder ();
a.accept (aBuilder);
errorProvider (aBuilder.build ());
}
return this;
}
@Nonnull
public Builder errorProvider (@Nullable final AgentPojo.Builder a)
{
return errorProvider (a == null ? null : a.build ());
}
@Nonnull
public Builder errorProvider (@Nullable final AgentType a)
{
return errorProvider (a == null ? null : AgentPojo.builder (a));
}
@Nonnull
public Builder errorProvider (@Nullable final AgentPojo a)
{
m_aErrorProvider = a;
return this;
}
@Nonnull
public final Builder addException (@Nullable final Consumer a)
{
if (a != null)
{
final EDMExceptionPojo.Builder aBuilder = EDMExceptionPojo.builder ();
a.accept (aBuilder);
addException (aBuilder.build ());
}
return this;
}
@Nonnull
public Builder addException (@Nullable final RegistryExceptionType a)
{
return addException (a == null ? null : EDMExceptionPojo.builder (a));
}
@Nonnull
public Builder addException (@Nullable final EDMExceptionPojo.Builder a)
{
return addException (a == null ? null : a.build ());
}
@Nonnull
public Builder addException (@Nullable final EDMExceptionPojo a)
{
if (a != null)
m_aExceptions.add (a);
return this;
}
@Nonnull
public final Builder exception (@Nullable final Consumer a)
{
if (a != null)
{
final EDMExceptionPojo.Builder aBuilder = EDMExceptionPojo.builder ();
a.accept (aBuilder);
exception (aBuilder.build ());
}
return this;
}
@Nonnull
public Builder exception (@Nullable final EDMExceptionPojo.Builder a)
{
return exception (a == null ? null : a.build ());
}
@Nonnull
public Builder exception (@Nullable final RegistryExceptionType a)
{
return exception (a == null ? null : EDMExceptionPojo.builder (a));
}
@Nonnull
public Builder exception (@Nullable final EDMExceptionPojo a)
{
if (a != null)
m_aExceptions.set (a);
else
m_aExceptions.clear ();
return this;
}
@Nonnull
public Builder exceptions (@Nullable final EDMExceptionPojo... a)
{
m_aExceptions.setAll (a);
return this;
}
@Nonnull
public Builder exceptions (@Nullable final Iterable a)
{
m_aExceptions.setAll (a);
return this;
}
@Nonnull
public Builder exceptions (@Nullable final Iterable a, @Nonnull final Function aMapper)
{
m_aExceptions.setAllMapped (a, aMapper);
return this;
}
public void checkConsistency ()
{
if (m_eResponseStatus == null)
throw new IllegalStateException ("Response Status must be present");
if (m_eResponseStatus != ERegRepResponseStatus.SUCCESS && m_eResponseStatus != ERegRepResponseStatus.FAILURE)
throw new IllegalStateException ("Response Status must be SUCCESS or FAILURE");
if (StringHelper.hasNoText (m_sRequestID))
throw new IllegalStateException ("Request ID must be present");
if (StringHelper.hasNoText (m_sSpecificationIdentifier))
throw new IllegalStateException ("SpecificationIdentifier must be present");
if (m_aExceptions.isEmpty ())
throw new IllegalStateException ("At least one Exception must be present");
}
@Nonnull
public EDMErrorResponse build ()
{
checkConsistency ();
return new EDMErrorResponse (m_eResponseStatus, m_sRequestID, m_sSpecificationIdentifier, m_aErrorProvider, m_aExceptions);
}
}
private static void _applySlots (@Nonnull final SlotType aSlot, @Nonnull final EDMErrorResponse.Builder aBuilder)
{
final String sName = aSlot.getName ();
final ValueType aSlotValue = aSlot.getSlotValue ();
switch (sName)
{
case SlotSpecificationIdentifier.NAME:
if (aSlotValue instanceof StringValueType)
{
final String sValue = ((StringValueType) aSlotValue).getValue ();
aBuilder.specificationIdentifier (sValue);
}
break;
case SlotErrorProvider.NAME:
if (aSlotValue instanceof AnyValueType)
{
final Node aAny = (Node) ((AnyValueType) aSlotValue).getAny ();
aBuilder.errorProvider (AgentPojo.builder (new AgentMarshaller ().read (aAny)));
}
break;
default:
throw new IllegalStateException ("Found unsupported slot '" + sName + "'");
}
}
@Nonnull
public static EDMErrorResponse create (@Nonnull final QueryResponse aQueryResponse)
{
final EDMErrorResponse.Builder aBuilder = EDMErrorResponse.builder ()
.responseStatus (ERegRepResponseStatus.getFromIDOrNull (aQueryResponse.getStatus ()))
.requestID (aQueryResponse.getRequestId ());
for (final SlotType aSlot : aQueryResponse.getSlot ())
_applySlots (aSlot, aBuilder);
for (final RegistryExceptionType aEx : aQueryResponse.getException ())
aBuilder.addException (aEx);
return aBuilder.build ();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy