com.exalead.mercury.mami.master.v10

Class PushAPISecurity

java.lang.Object

com.exalead.mercury.mami.master.v10.PushAPISecurity

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class PushAPISecurity
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

PushAPI Security
Warning on contrary to MAMI Security and Search API Security, the login and password are configured at the connector config level.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_USE_HTTPS
java.lang.String	serverCertificate
boolean	useHttps

Constructor Summary

Constructors

Constructor and Description
PushAPISecurity()
PushAPISecurity(PushAPISecurity o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this PushAPISecurity.
static PushAPISecurity	fromString(java.lang.String s) String representation of this PushAPISecurity.
java.lang.String	getServerCertificate() When using HTTPS, name of a sertificate inside the security folder of the data directory.
boolean	isUseHttps() Secures connection with HTTPS.
PushAPISecurity	makeCopy() Creates and returns a deep copy of this PushAPISecurity.
static PushAPISecurity	readFrom(java.io.InputStream is) Read this PushAPISecurity from an XML fragment.
void	setServerCertificate(java.lang.String serverCertificate) When using HTTPS, name of a sertificate inside the security folder of the data directory.
void	setUseHttps(boolean useHttps) Secures connection with HTTPS.
java.lang.String	toString() String representation of this PushAPISecurity.
PushAPISecurity	withServerCertificate(java.lang.String serverCertificate)
PushAPISecurity	withUseHttps(boolean useHttps)
PushAPISecurity	withUseHttps(java.lang.Boolean useHttps)
void	writeTo(java.io.OutputStream os) Write this PushAPISecurity as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serverCertificate

public java.lang.String serverCertificate

useHttps

public boolean useHttps

DEFAULT_USE_HTTPS

public static final boolean DEFAULT_USE_HTTPS

See Also:

Constant Field Values

Constructor Detail

PushAPISecurity

public PushAPISecurity()

PushAPISecurity

public PushAPISecurity(PushAPISecurity o)

Copy constructor

Method Detail

setServerCertificate

public void setServerCertificate(java.lang.String serverCertificate)

When using HTTPS, name of a sertificate inside the security folder of the data directory. When not provided the default certificate is used.

getServerCertificate

public java.lang.String getServerCertificate()

When using HTTPS, name of a sertificate inside the security folder of the data directory. When not provided the default certificate is used.

withServerCertificate

public PushAPISecurity withServerCertificate(java.lang.String serverCertificate)

setUseHttps

public void setUseHttps(boolean useHttps)

Secures connection with HTTPS.

isUseHttps

public boolean isUseHttps()

Secures connection with HTTPS.

withUseHttps

public PushAPISecurity withUseHttps(boolean useHttps)

withUseHttps

public PushAPISecurity withUseHttps(java.lang.Boolean useHttps)

makeCopy

public PushAPISecurity makeCopy()

Creates and returns a deep copy of this PushAPISecurity.

readFrom

public static PushAPISecurity readFrom(java.io.InputStream is)
                                throws javax.xml.bind.JAXBException

Read this PushAPISecurity from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this PushAPISecurity as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static PushAPISecurity fromString(java.lang.String s)
                                  throws javax.xml.bind.JAXBException,
                                         java.io.UnsupportedEncodingException

String representation of this PushAPISecurity.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PushAPISecurity.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this PushAPISecurity.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException