Home » geronimo-2.2-source-release » org.apache.geronimo.mail » [javadoc | source]
org.apache.geronimo.mail
public class: ProtocolGBean [javadoc | source]
java.lang.Object
   org.apache.geronimo.mail.ProtocolGBean

All Implemented Interfaces:
    GBeanLifecycle

Direct Known Subclasses:
    NNTPStoreGBean, SMTPSTransportGBean, NNTPTransportGBean, POP3StoreGBean, SMTPTransportGBean, IMAPStoreGBean

A generic GBean that provides for the configuration of a JavaMail protocol.

Values that are set in the individual member variables will override any of the corresponding values that have been set in the properties set.

Field Summary
public static final  String GBEAN_OBJECTNAME     
public static final  String GBEAN_PROTOCOL     
public static final  String GBEAN_PROPERTIES     
public static final  String GBEAN_HOST     
public static final  String GBEAN_USER     
public static final  String GBEAN_ADD_OVERRIDES     
public static final  String GBEAN_PORT     
public static final  String GBEAN_CONNECTION_TIMEOUT     
public static final  String GBEAN_TIMEOUT     
public static final  String GBEAN_FROM     
public static final  String GBEAN_AUTH     
public static final  String GBEAN_REALM     
public static final  String GBEAN_QUITWAIT     
public static final  String GBEAN_FACTORY_CLASS     
public static final  String GBEAN_FACTORY_FALLBACK     
public static final  String GBEAN_FACTORY_PORT     
public static final  String GBEAN_LOCALHOST     
public static final  String GBEAN_LOCALADDRESS     
public static final  String GBEAN_LOCALPORT     
public static final  GBeanInfo GBEAN_INFO     
Constructor:
 public ProtocolGBean() 
 public ProtocolGBean(String objectName,
    String protocol,
    Properties properties,
    String host,
    String user) 
    Construct an instance of ProtocolGBean

    Values that are set in the individual member variables will override any of the corresponding values that have been set in the properties set.

    Parameters:
    objectName - the object name of the protocol
    protocol - the name of the protocol
    properties - the set of default properties for the protocol
    host - the host the protocol connects to
    user - the default name for the protocol
Method from org.apache.geronimo.mail.ProtocolGBean Summary:
addOverrides,   doFail,   doStart,   doStop,   getGBeanInfo,   getHost,   getObjectName,   getProperties,   getProtocol,   getUser,   setHost,   setProperties,   setUser
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.geronimo.mail.ProtocolGBean Detail:
 public  void addOverrides(Properties props) 
    Add the overrides from the member variables to the properties file.
 public  void doFail() 
 public  void doStart() throws Exception 
 public  void doStop() throws Exception 
 public static GBeanInfo getGBeanInfo() 
 public String getHost() 
    Returns the host the protocol connects to.
 public String getObjectName() 
    Returns the object name of this protocol GBean
 public Properties getProperties() 
    Returns the set of default properties for the protocol.

    Values that are set in the individual member variables will override any of the corresponding values that have been set in the properties set.

 public String getProtocol() 
    Returns the name of the protocol
 public String getUser() 
    Returns the default user name for the protocol.
 public  void setHost(String host) 
    Set the host the protocol connects to.
 public  void setProperties(Properties properties) 
    Sets the set of default properties for the protocol.

    Values that are set in the individual member variables will override any of the corresponding values that have been set in the properties set.

 public  void setUser(String user) 
    Sets the default user name for the protocol.