com.exalead.mercury.mami.master.v10

Class PublicAPISecurity

java.lang.Object

com.exalead.mercury.mami.master.v10.PublicAPISecurity

All Implemented Interfaces:

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

Direct Known Subclasses:

MAMISecurity, SearchAPISecurity

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

Base class for public API security.
Defines whether connection should be authenticated and/or secured.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_USE_HTTPS
java.util.List<IPRule>	iPRule
java.lang.String	login
java.lang.String	password
java.lang.String	serverCertificate
boolean	useHttps

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this PublicAPISecurity.
static PublicAPISecurity	fromString(java.lang.String s) String representation of this PublicAPISecurity.
java.util.List<IPRule>	getIPRule() Deprecated.
java.lang.String	getLogin() Login.
java.lang.String	getPassword() Password.
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.
PublicAPISecurity	makeCopy()
static PublicAPISecurity	readFrom(java.io.InputStream is) Read this PublicAPISecurity from an XML fragment.
void	setLogin(java.lang.String login) Login.
void	setPassword(java.lang.String password) Password.
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 PublicAPISecurity.
PublicAPISecurity	withIPRule(java.util.Collection<IPRule> __values)
PublicAPISecurity	withIPRule(IPRule... __values) Deprecated.
PublicAPISecurity	withLogin(java.lang.String login)
PublicAPISecurity	withPassword(java.lang.String password)
PublicAPISecurity	withServerCertificate(java.lang.String serverCertificate)
PublicAPISecurity	withUseHttps(boolean useHttps)
PublicAPISecurity	withUseHttps(java.lang.Boolean useHttps)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

iPRule

public java.util.List<IPRule> iPRule

login

public java.lang.String login

password

public java.lang.String password

useHttps

public boolean useHttps

DEFAULT_USE_HTTPS

public static final boolean DEFAULT_USE_HTTPS

See Also:

Constant Field Values

serverCertificate

public java.lang.String serverCertificate

Constructor Detail

PublicAPISecurity

public PublicAPISecurity()

PublicAPISecurity

public PublicAPISecurity(PublicAPISecurity o)

Copy constructor

Method Detail

getIPRule

@Deprecated
public java.util.List<IPRule> getIPRule()

Deprecated.

withIPRule

@Deprecated
public PublicAPISecurity withIPRule(IPRule... __values)

Deprecated.

withIPRule

public PublicAPISecurity withIPRule(java.util.Collection<IPRule> __values)

setLogin

public void setLogin(java.lang.String login)

Login.
Set to null to disable authentication.

getLogin

public java.lang.String getLogin()

Login.
Set to null to disable authentication.

withLogin

public PublicAPISecurity withLogin(java.lang.String login)

setPassword

public void setPassword(java.lang.String password)

Password.
Encrypted using product RSA encryption key.

getPassword

public java.lang.String getPassword()

Password.
Encrypted using product RSA encryption key.

withPassword

public PublicAPISecurity withPassword(java.lang.String password)

setUseHttps

public void setUseHttps(boolean useHttps)

Secures connection with HTTPS.

isUseHttps

public boolean isUseHttps()

Secures connection with HTTPS.

withUseHttps

public PublicAPISecurity withUseHttps(boolean useHttps)

withUseHttps

public PublicAPISecurity withUseHttps(java.lang.Boolean useHttps)

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 PublicAPISecurity withServerCertificate(java.lang.String serverCertificate)

makeCopy

public PublicAPISecurity makeCopy()

readFrom

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

Read this PublicAPISecurity 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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this PublicAPISecurity.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PublicAPISecurity.

Overrides:

toString in class java.lang.Object

check

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

Checks this PublicAPISecurity.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException