Email Answering System
Version 1.0

com.ninecode.email.connector
Class EmailConnectionMetaData

java.lang.Object
  |
  +--com.ninecode.email.connector.EmailConnectionMetaData
All Implemented Interfaces:
ConnectionMetaData

public class EmailConnectionMetaData
extends Object
implements ConnectionMetaData

Meta information about the underlying javax.mail providers.

Author:
Derrick Oswald

Field Summary
protected  EmailConnection mConnection
          This metadata's connection.
protected  ManagedConnectionMetaData mManagedConnectionMetaData
          The managed connection meta data.
 
Constructor Summary
EmailConnectionMetaData(EmailConnection connection)
          Create an EmailConnectionMetaData object.
 
Method Summary
 String getEISProductName()
          Returns product name of the underlying EIS instance.
 String getEISProductVersion()
          Returns product version of the underlying EIS instance.
 String getUserName()
          Returns the user name for an active connection as known to the underlying EIS instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mConnection

protected EmailConnection mConnection
This metadata's connection.


mManagedConnectionMetaData

protected ManagedConnectionMetaData mManagedConnectionMetaData
The managed connection meta data.

Constructor Detail

EmailConnectionMetaData

public EmailConnectionMetaData(EmailConnection connection)
Create an EmailConnectionMetaData object.

Parameters:
connection - The connection to provide metadata for.
Method Detail

getEISProductName

public String getEISProductName()
                         throws ResourceException
Returns product name of the underlying EIS instance. The name of the EIS connected through the Connection that produced this metadata, is interrogated for product name.

Specified by:
getEISProductName in interface ConnectionMetaData
Returns:
Product name of the EIS instance.
Throws:
ResourceException - Failed to get the information for the EIS instance.

getEISProductVersion

public String getEISProductVersion()
                            throws ResourceException
Returns product version of the underlying EIS instance.

Specified by:
getEISProductVersion in interface ConnectionMetaData
Returns:
Product version of an EIS instance.
Throws:
ResourceException - Failed to get the information for the EIS instance.

getUserName

public String getUserName()
                   throws ResourceException
Returns the user name for an active connection as known to the underlying EIS instance. The name corresponds the resource principal under whose security context a connection to the EIS instance has been established.

Specified by:
getUserName in interface ConnectionMetaData
Returns:
String representing the user name.
Throws:
ResourceException - Failed to get the information for the EIS instance.

Email Answering System
Version 1.0

Copyright © 2003 Derrick Oswald. All rights reserved.