|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.navigation.HttpENEConnection com.endeca.navigation.AuthHttpENEConnection
public class AuthHttpENEConnection
Extends HttpENEConnection
to provide a connection over to
an Endeca MDEX Engine over HTTP that requires
authentication. Use instances of this class to connect to the
MDEX Engine via the Endeca Access Control System.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.endeca.navigation.HttpENEConnection |
---|
HttpENEConnection.HttpHeader |
Constructor Summary | |
---|---|
AuthHttpENEConnection()
Default empty constructor. |
|
AuthHttpENEConnection(String hostname,
int port)
Constructor for connection to an Endeca MDEX Engine over HTTP. |
|
AuthHttpENEConnection(String hostname,
String port)
Constructor for connection to an Endeca MDEX Engine over HTTP. |
Method Summary | |
---|---|
protected void |
finalize()
|
void |
login(CallbackHandler handler)
Authenticate a user. |
void |
logout()
Logout an authenticated user. |
ENEQueryResults |
query(ENEQuery neq)
Issues a query against the MDEX Engine. |
Methods inherited from class com.endeca.navigation.HttpENEConnection |
---|
addHttpHeader, enableSSL, enableSSL, getHostname, getMaxUrl, getPort, setHostname, setHostnameVerifier, setMaxUrl, setPort, setPort |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AuthHttpENEConnection()
login(CallbackHandler)
method will need to be called
before query
is called, else a
ENEQueryException
will be thrown.
public AuthHttpENEConnection(String hostname, String port)
login(CallbackHandler)
before the query
method is called, otherwise a
ENEQueryException
will be thrown.
hostname
- hostname or IP address of the MDEX Engine.
Example: 127.0.0.1 or engine.endeca.com.port
- port of the MDEX Engine. Example: 5001.public AuthHttpENEConnection(String hostname, int port)
login(CallbackHandler)
before the query method is called, otherwise a
ENEQueryException
will be thrown.
hostname
- hostname or IP address of the MDEX Engine.
Example: 127.0.0.1 or engine.endeca.com.port
- port of the MDEX Engine. Example: 5001.Method Detail |
---|
public ENEQueryResults query(ENEQuery neq) throws ENEQueryException
query
method returns a
ENEQueryResults
object which contains the
resultant objects returned by the MDEX Engine in
response to the query neq
.
query
in interface ENEConnection
query
in class HttpENEConnection
neq
- the query object containing the navigation, record etc.
type requests to the MDEX Engine
ENEQueryResults
object that contains the results
of the query.
ENEQueryException
- if there is a
problem making the query. Possible subclasses of
ENEQueryException
that could be thrown are
ENEConnectionException
,
EmptyENEQueryException
,
PartialENEQueryException
,
ENEException
,
VersionMismatchException
, and so on.public void login(CallbackHandler handler) throws ENEAuthenticationException
handler
- An object instance that provides the
mechanism to obtain credentials for authentication
purposes. For example, the StaticCallbackHandler
class
can be used to construct the handler object.
ENEAuthenticationException
- if the login fails
for any reason, including bad credentials.public void logout() throws ENEAuthenticationException
ENEAuthenticationException
- if the operation
fails for any reason.protected void finalize() throws Throwable
finalize
in class Object
Throwable
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |