com.helger.phase4.entsog.Phase4ENTSOGSender Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of phase4-entsog-client Show documentation
Show all versions of phase4-entsog-client Show documentation
ENTSOG AS4 client for outgoing transmissions
/*
* Copyright (C) 2015-2024 Pavel Rotek
* pavel[dot]rotek[at]gmail[dot]com
*
* Copyright (C) 2021-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.phase4.entsog;
import java.io.IOException;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.OverridingMethodsMustInvokeSuper;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.phase4.attachment.AS4OutgoingAttachment;
import com.helger.phase4.attachment.WSS4JAttachment;
import com.helger.phase4.crypto.ECryptoKeyIdentifierType;
import com.helger.phase4.profile.entsog.AS4ENTSOGProfileRegistarSPI;
import com.helger.phase4.sender.AbstractAS4UserMessageBuilderMIMEPayload;
import com.helger.phase4.util.AS4ResourceHelper;
/**
* This class contains all the specifics to send AS4 messages with the ENTSOG
* profile. See sendAS4Message as the main method to trigger the
* sending, with all potential customization.
*
* @author Pavel Rotek
* @since 0.14.0
*/
@Immutable
public final class Phase4ENTSOGSender
{
private static final Logger LOGGER = LoggerFactory.getLogger (Phase4ENTSOGSender.class);
private Phase4ENTSOGSender ()
{}
/**
* @return Create a new Builder for AS4 messages if the payload is present.
* Never null.
*/
@Nonnull
public static ENTSOGUserMessageBuilder builder ()
{
return new ENTSOGUserMessageBuilder ();
}
/**
* Abstract ENTSOG UserMessage builder class with sanity methods
*
* @author Philip Helger
* @param
* The implementation type
*/
public abstract static class AbstractENTSOGUserMessageBuilder >
extends
AbstractAS4UserMessageBuilderMIMEPayload
{
public static final ECryptoKeyIdentifierType DEFAULT_KEY_IDENTIFIER_TYPE = ECryptoKeyIdentifierType.ISSUER_SERIAL;
private ENTSOGPayloadParams m_aPayloadParams;
protected AbstractENTSOGUserMessageBuilder ()
{
// Override default values
try
{
as4ProfileID (AS4ENTSOGProfileRegistarSPI.AS4_PROFILE_ID);
httpClientFactory (new Phase4ENTSOGHttpClientSettings ());
signingParams ().setKeyIdentifierType (DEFAULT_KEY_IDENTIFIER_TYPE);
cryptParams ().setKeyIdentifierType (DEFAULT_KEY_IDENTIFIER_TYPE);
conversationID ("");
}
catch (final Exception ex)
{
throw new IllegalStateException ("Failed to init AS4 Client builder", ex);
}
}
/**
* Encryption Key Identifier Type.
*
* @param eEncryptionKeyIdentifierType
* {@link ECryptoKeyIdentifierType}. Defaults to ISSUER_SERIAL. May
* be null.
* @return this for chaining
*/
@Nonnull
public final IMPLTYPE encryptionKeyIdentifierType (@Nullable final ECryptoKeyIdentifierType eEncryptionKeyIdentifierType)
{
if (eEncryptionKeyIdentifierType != null)
cryptParams ().setKeyIdentifierType (eEncryptionKeyIdentifierType);
return thisAsT ();
}
/**
* Signing Key Identifier Type.
*
* @param eSigningKeyIdentifierType
* {@link ECryptoKeyIdentifierType}. Defaults to ISSUER_SERIAL. May
* be null.
* @return this for chaining
* @deprecated Use
* {@link #signingKeyIdentifierType(ECryptoKeyIdentifierType)}
* instead
*/
@Deprecated (forRemoval = true, since = "2.2.2")
@Nonnull
public final IMPLTYPE setSigningKeyIdentifierType (@Nullable final ECryptoKeyIdentifierType eSigningKeyIdentifierType)
{
return signingKeyIdentifierType (eSigningKeyIdentifierType);
}
/**
* Signing Key Identifier Type.
*
* @param eSigningKeyIdentifierType
* {@link ECryptoKeyIdentifierType}. Defaults to ISSUER_SERIAL. May
* be null.
* @return this for chaining
* @since 2.2.2
*/
@Nonnull
public final IMPLTYPE signingKeyIdentifierType (@Nullable final ECryptoKeyIdentifierType eSigningKeyIdentifierType)
{
if (eSigningKeyIdentifierType != null)
signingParams ().setKeyIdentifierType (eSigningKeyIdentifierType);
return thisAsT ();
}
/**
* Set the payload to be send out.
*
* @param aBuilder
* The payload builder to be used. GZip compression is automatically.
* enforced.
* @param aPayloadParams
* The payload params to use. May be null.
* @return this for chaining
*/
@Nonnull
public final IMPLTYPE payload (@Nullable final AS4OutgoingAttachment.Builder aBuilder,
@Nullable final ENTSOGPayloadParams aPayloadParams)
{
payload (aBuilder != null ? aBuilder.compressionGZIP ().build () : null);
m_aPayloadParams = aPayloadParams;
return thisAsT ();
}
@Override
@OverridingMethodsMustInvokeSuper
public boolean isEveryRequiredFieldSet ()
{
if (!super.isEveryRequiredFieldSet ())
return false;
if (m_aPayload == null)
{
LOGGER.warn ("The field 'payload' is not set");
return false;
}
if (!"".equals (m_sConversationID))
{
LOGGER.warn ("The field 'conversationID' must not be changed");
return false;
}
// All valid
return true;
}
@Override
protected WSS4JAttachment createMainAttachment (@Nonnull final AS4OutgoingAttachment aPayload,
@Nonnull final AS4ResourceHelper aResHelper) throws IOException
{
final WSS4JAttachment aPayloadAttachment = WSS4JAttachment.createOutgoingFileAttachment (aPayload, aResHelper);
if (m_aPayloadParams != null)
{
if (m_aPayloadParams.getDocumentType () != null)
aPayloadAttachment.customPartProperties ().put ("EDIGASDocumentType", m_aPayloadParams.getDocumentType ());
}
return aPayloadAttachment;
}
}
/**
* The builder class for sending AS4 messages using ENTSOG profile specifics.
* Use {@link #sendMessage()} to trigger the main transmission.
*
* @author Philip Helger
*/
public static class ENTSOGUserMessageBuilder extends AbstractENTSOGUserMessageBuilder
{
public ENTSOGUserMessageBuilder ()
{}
}
/**
* Additional parameters to add in the PayloadInfo part of AS4 UserMessage
*
* @author Pavel Rotek
*/
@NotThreadSafe
public static class ENTSOGPayloadParams
{
private String m_sDocumentType;
/**
* @return ENTSOG payload document type according to EDIG@S. Eg. "01G" for
* EDIG@S Nomination document.
*/
@Nullable
public String getDocumentType ()
{
return m_sDocumentType;
}
/**
* ENTSOG payload document type
*
* @param sDocumentType
* Document type to use. May be null.
*/
public void setDocumentType (@Nullable final String sDocumentType)
{
m_sDocumentType = sDocumentType;
}
}
}