com.helger.erechnung.erb.ws.AbstractWSSender Maven / Gradle / Ivy
/*
* Copyright (C) 2014-2023 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.erechnung.erb.ws;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import javax.xml.namespace.NamespaceContext;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.string.ToStringGenerator;
import com.helger.commons.traits.IGenericImplTrait;
/**
* Abstract base class for for the e-Rechnung.gv.at Webservice wrapper.
*
* @author Philip Helger
* @param
* The real implementation type
*/
@NotThreadSafe
public abstract class AbstractWSSender > implements
IGenericImplTrait
{
// Default encoding according to XSD
public static final Charset DEFAULT_INVOICE_ENCODING = StandardCharsets.UTF_8;
public static final boolean DEFAULT_DEBUG = false;
public static final boolean DEFAULT_TRUST_ALL_CERTIFICATES = false;
public static final boolean DEFAULT_TRUST_ALL_HOSTNAMES = false;
private final String m_sWebserviceUsername;
private final String m_sWebservicePassword;
private Charset m_aInvoiceEncoding = DEFAULT_INVOICE_ENCODING;
private boolean m_bDebugMode = DEFAULT_DEBUG;
private boolean m_bTrustAllCertificates = DEFAULT_TRUST_ALL_CERTIFICATES;
private boolean m_bTrustAllHostnames = DEFAULT_TRUST_ALL_HOSTNAMES;
private NamespaceContext m_aNSCtx;
public AbstractWSSender (@Nonnull @Nonempty final String sWebserviceUsername,
@Nonnull @Nonempty final String sWebservicePassword)
{
m_sWebserviceUsername = ValueEnforcer.notEmpty (sWebserviceUsername, "Webservice Username");
m_sWebservicePassword = ValueEnforcer.notEmpty (sWebservicePassword, "Webservice Password");
}
/**
* @return The web service user name as specified in the constructor. Neither
* null nor empty.
*/
@Nonnull
@Nonempty
public final String getWebserviceUsername ()
{
return m_sWebserviceUsername;
}
/**
* @return The web service password as specified in the constructor. Neither
* null nor empty.
*/
@Nonnull
@Nonempty
public final String getWebservicePassword ()
{
return m_sWebservicePassword;
}
/**
* @return The encoding of the XML invoice to be used. The default value is
* {@link #DEFAULT_INVOICE_ENCODING}.
*/
@Nonnull
public final Charset getInvoiceEncoding ()
{
return m_aInvoiceEncoding;
}
/**
* Set the encoding of the original XML invoice to be used. The default value
* is {@link #DEFAULT_INVOICE_ENCODING}.
*
* @param aInvoiceEncoding
* The new encoding to be used. May not be null.
* @return this
*/
@Nonnull
public final IMPLTYPE setInvoiceEncoding (@Nonnull final Charset aInvoiceEncoding)
{
ValueEnforcer.notNull (aInvoiceEncoding, "InvoiceEncoding");
m_aInvoiceEncoding = aInvoiceEncoding;
return thisAsT ();
}
/**
* @return true if the debug mode is enabled, false
* if not. The default value is {@link #DEFAULT_DEBUG}.
*/
public final boolean isDebugMode ()
{
return m_bDebugMode;
}
/**
* Change the setting of the debug mode. Enabling the debug mode means, that
* the exchanged Webservice messages are logged to stdout.
*
* @param bDebugMode
* The new value of the debug flag. true to enable debug
* mode, false to disable it.
* @return this
*/
@Nonnull
public final IMPLTYPE setDebugMode (final boolean bDebugMode)
{
m_bDebugMode = bDebugMode;
return thisAsT ();
}
/**
* @return true if the Webservice connection trusts all
* certificates and therefore does not check for certificate
* revocation etc. If this is enabled, the security of transmission
* cannot be guaranteed! The default value is
* {@link #DEFAULT_TRUST_ALL_CERTIFICATES}.
*/
public final boolean isTrustAllCertificates ()
{
return m_bTrustAllCertificates;
}
/**
* Change whether the the Webservice connection trusts all certificates and
* therefore does not check for certificate revocation etc. If this is
* enabled, the security of transmission cannot be guaranteed! The default
* value is {@link #DEFAULT_TRUST_ALL_CERTIFICATES}.
* Internally a special {@link javax.net.ssl.SSLContext} with a
* {@link com.helger.commons.ws.TrustManagerTrustAll} is created.
*
* @param bTrustAllCertificates
* true to lower the security level and disable the
* certificate check, or false to enable the certificate
* check.
* @return this
*/
@Nonnull
public final IMPLTYPE setTrustAllCertificates (final boolean bTrustAllCertificates)
{
m_bTrustAllCertificates = bTrustAllCertificates;
return thisAsT ();
}
/**
* @return true if the Webservice connection does not check the
* hostname as specified in the certificate of the receiver. For
* ER> using the txm.portal.at service, this should always be
* false. If this is enabled, the security of
* transmission cannot be guaranteed! The default value is
* {@link #DEFAULT_TRUST_ALL_HOSTNAMES}. For ER>B the hostname
* check should always be enabled.
*/
public final boolean isTrustAllHostnames ()
{
return m_bTrustAllHostnames;
}
/**
* Change whether the the Webservice connection should check the hostname as
* specified in the certificate of the receiver or not. If this is enabled,
* the security of transmission cannot be guaranteed! The default value is
* {@link #DEFAULT_TRUST_ALL_HOSTNAMES}. For ER>B the hostname check should
* always be enabled.
* Internally a special
* {@link com.helger.commons.ws.HostnameVerifierVerifyAll} is installed.
*
* @param bTrustAllHostnames
* true to lower the security level and trust all
* hostnames, or false to enable the certificate hostname
* check.
* @return this
*/
@Nonnull
public final IMPLTYPE setTrustAllHostnames (final boolean bTrustAllHostnames)
{
m_bTrustAllHostnames = bTrustAllHostnames;
return thisAsT ();
}
/**
* @return The namespace context (the mapping from XML prefix to namespace
* URL). May be null.
*/
@Nullable
public final NamespaceContext getNamespaceContext ()
{
return m_aNSCtx;
}
/**
* Set the namespace context to be used. This is only used, if a conversion
* from DOMNode to a byte array is performed.
*
* @param aNSCtx
* The namespace context to be used. May be null.
* @return this for chaining
*/
@Nonnull
public final IMPLTYPE setNamespaceContext (@Nullable final NamespaceContext aNSCtx)
{
m_aNSCtx = aNSCtx;
return thisAsT ();
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("webserviceUsername", m_sWebserviceUsername)
.appendPassword ("webservicePassword")
.append ("invoiceEncoding", m_aInvoiceEncoding)
.append ("debugMode", m_bDebugMode)
.append ("trustAllCertificates", m_bTrustAllCertificates)
.append ("trustAllHostnames", m_bTrustAllHostnames)
.append ("NSCtx", m_aNSCtx)
.getToString ();
}
}