com.exalead.mercury.mami.master.v10

Class SearchAPISecurity

java.lang.Object

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

com.exalead.mercury.mami.master.v10.SearchAPISecurity

All Implemented Interfaces:

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

public class SearchAPISecurity
extends PublicAPISecurity
implements com.exalead.util.Checkable, java.io.Serializable

Class used for search API security (search, fetch).
Defines whether the connection to the search API should be authenticated and/or secured.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.exalead.mercury.mami.master.v10.PublicAPISecurity

DEFAULT_USE_HTTPS, iPRule, login, password, serverCertificate, useHttps

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SearchAPISecurity.
static SearchAPISecurity	fromString(java.lang.String s) String representation of this SearchAPISecurity.
SearchAPISecurity	makeCopy() Creates and returns a deep copy of this SearchAPISecurity.
static SearchAPISecurity	readFrom(java.io.InputStream is) Read this SearchAPISecurity from an XML fragment.
java.lang.String	toString() String representation of this SearchAPISecurity.
SearchAPISecurity	withIPRule(java.util.Collection<IPRule> __values)
SearchAPISecurity	withIPRule(IPRule... __values) Deprecated.
SearchAPISecurity	withLogin(java.lang.String login)
SearchAPISecurity	withPassword(java.lang.String password)
SearchAPISecurity	withServerCertificate(java.lang.String serverCertificate)
SearchAPISecurity	withUseHttps(boolean useHttps)
SearchAPISecurity	withUseHttps(java.lang.Boolean useHttps)
void	writeTo(java.io.OutputStream os) Write this SearchAPISecurity as an XML fragment

Methods inherited from class com.exalead.mercury.mami.master.v10.PublicAPISecurity

getIPRule, getLogin, getPassword, getServerCertificate, isUseHttps, setLogin, setPassword, setServerCertificate, setUseHttps

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchAPISecurity

public SearchAPISecurity()

SearchAPISecurity

public SearchAPISecurity(SearchAPISecurity o)

Copy constructor

Method Detail

withIPRule

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

Deprecated.

Overrides:

withIPRule in class PublicAPISecurity

withIPRule

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

Overrides:

withIPRule in class PublicAPISecurity

withLogin

public SearchAPISecurity withLogin(java.lang.String login)

Overrides:

withLogin in class PublicAPISecurity

withPassword

public SearchAPISecurity withPassword(java.lang.String password)

Overrides:

withPassword in class PublicAPISecurity

withUseHttps

public SearchAPISecurity withUseHttps(boolean useHttps)

Overrides:

withUseHttps in class PublicAPISecurity

withUseHttps

public SearchAPISecurity withUseHttps(java.lang.Boolean useHttps)

Overrides:

withUseHttps in class PublicAPISecurity

withServerCertificate

public SearchAPISecurity withServerCertificate(java.lang.String serverCertificate)

Overrides:

withServerCertificate in class PublicAPISecurity

makeCopy

public SearchAPISecurity makeCopy()

Creates and returns a deep copy of this SearchAPISecurity.

Overrides:

makeCopy in class PublicAPISecurity

readFrom

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

Read this SearchAPISecurity 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 SearchAPISecurity as an XML fragment

Overrides:

writeTo in class PublicAPISecurity

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SearchAPISecurity.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SearchAPISecurity.

Overrides:

toString in class PublicAPISecurity

check

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

Checks this SearchAPISecurity.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class PublicAPISecurity

Throws:

com.exalead.util.TypedException