public JMSAppender() 
{

}

 public  void activateOptions() 
{
    TopicConnectionFactory  topicConnectionFactory;
    try {
      Context jndi;
      LogLog.debug("Getting initial context.");
      if(initialContextFactoryName != null) {
	Properties env = new Properties( );
	env.put(Context.INITIAL_CONTEXT_FACTORY, initialContextFactoryName);
	if(providerURL != null) {
	  env.put(Context.PROVIDER_URL, providerURL);
	} else {
	  LogLog.warn("You have set InitialContextFactoryName option but not the "
		     +"ProviderURL. This is likely to cause problems.");
	}
	if(urlPkgPrefixes != null) {
	  env.put(Context.URL_PKG_PREFIXES, urlPkgPrefixes);
	}
	if(securityPrincipalName != null) {
	  env.put(Context.SECURITY_PRINCIPAL, securityPrincipalName);
	  if(securityCredentials != null) {
	    env.put(Context.SECURITY_CREDENTIALS, securityCredentials);
	  } else {
	    LogLog.warn("You have set SecurityPrincipalName option but not the "
			+"SecurityCredentials. This is likely to cause problems.");
	  }
	}	
	jndi = new InitialContext(env);
      } else {
	jndi = new InitialContext();
      }
      LogLog.debug("Looking up ["+tcfBindingName+"]");
      topicConnectionFactory = (TopicConnectionFactory) lookup(jndi, tcfBindingName);
      LogLog.debug("About to create TopicConnection.");
      if(userName != null) {
	topicConnection = topicConnectionFactory.createTopicConnection(userName, 
								       password); 
      } else {
	topicConnection = topicConnectionFactory.createTopicConnection();
      }
      LogLog.debug("Creating TopicSession, non-transactional, "
		   +"in AUTO_ACKNOWLEDGE mode.");
      topicSession = topicConnection.createTopicSession(false,
							Session.AUTO_ACKNOWLEDGE);
      LogLog.debug("Looking up topic name ["+topicBindingName+"].");
      Topic topic = (Topic) lookup(jndi, topicBindingName);
      LogLog.debug("Creating TopicPublisher.");
      topicPublisher = topicSession.createPublisher(topic);
      LogLog.debug("Starting TopicConnection.");
      topicConnection.start();
      jndi.close();
    } catch(Exception e) {
      errorHandler.error("Error while activating options for appender named ["+name+
			 "].", e, ErrorCode.GENERIC_FAILURE);
    }
}

Options are activated and become effective only after calling this method.

 public  void append(LoggingEvent event) 
{
    if(!checkEntryConditions()) {
      return;
    }
    try {
      ObjectMessage msg = topicSession.createObjectMessage();
      if(locationInfo) {
	event.getLocationInformation();
      }
      msg.setObject(event);
      topicPublisher.publish(msg);
    } catch(Exception e) {
      errorHandler.error("Could not publish message in JMSAppender ["+name+"].", e,
			 ErrorCode.GENERIC_FAILURE);
    }
}

This method called by AppenderSkeleton#doAppend method to do most of the real appending work.

 protected boolean checkEntryConditions() 
{
    String fail = null;
    if(this.topicConnection == null) {
      fail = "No TopicConnection";
    } else if(this.topicSession == null) {
      fail = "No TopicSession";
    } else if(this.topicPublisher == null) {
      fail = "No TopicPublisher";
    }
    if(fail != null) {
      errorHandler.error(fail +" for JMSAppender named ["+name+"].");
      return false;
    } else {
      return true;
    }
}

 public synchronized  void close() 
{
    // The synchronized modifier avoids concurrent append and close operations
    if(this.closed)
      return;
    LogLog.debug("Closing appender ["+name+"].");
    this.closed = true;
    try {
      if(topicSession != null)
	topicSession.close();
      if(topicConnection != null)
	topicConnection.close();
    } catch(Exception e) {
      LogLog.error("Error while closing JMSAppender ["+name+"].", e);
    }
    // Help garbage collection
    topicPublisher = null;
    topicSession = null;
    topicConnection = null;
}

Close this JMSAppender. Closing releases all resources used by the appender. A closed appender cannot be re-opened.

 public String getInitialContextFactoryName() 
{
    return initialContextFactoryName;
}

Returns the value of the InitialContextFactoryName option. See #setInitialContextFactoryName for more details on the meaning of this option.

 public boolean getLocationInfo() 
{
    return locationInfo;
}

Returns value of the LocationInfo property which determines whether location (stack) info is sent to the remote subscriber.

 public String getPassword() 
{
    return password;
}

 public String getProviderURL() 
{
    return providerURL;
}

 public String getSecurityCredentials() 
{
    return securityCredentials;
}

 public String getSecurityPrincipalName() 
{
    return securityPrincipalName;
}

 public String getTopicBindingName() 
{
    return topicBindingName;
}

Returns the value of the TopicBindingName option.

 protected TopicConnection getTopicConnection() 
{
    return topicConnection;
}

Returns the TopicConnection used for this appender. Only valid after activateOptions() method has been invoked.

 public String getTopicConnectionFactoryBindingName() 
{
    return tcfBindingName;
}

Returns the value of the TopicConnectionFactoryBindingName option.

 protected TopicPublisher getTopicPublisher() 
{
    return topicPublisher;
}

Returns the TopicPublisher used for this appender. Only valid after activateOptions() method has been invoked.

 protected TopicSession getTopicSession() 
{
    return topicSession;
}

Returns the TopicSession used for this appender. Only valid after activateOptions() method has been invoked.

 String getURLPkgPrefixes() 
{
    return urlPkgPrefixes;
}

 public String getUserName() 
{
    return userName;
}

 protected Object lookup(Context ctx,
    String name) throws NamingException 
{
    try {
      return ctx.lookup(name);
    } catch(NameNotFoundException e) {
      LogLog.error("Could not find name ["+name+"].");
      throw e;
    }
}

 public boolean requiresLayout() 
{
    return false;
}

The JMSAppender sends serialized events and consequently does not require a layout.

 public  void setInitialContextFactoryName(String initialContextFactoryName) 
{
    this.initialContextFactoryName = initialContextFactoryName;
}

Setting the InitialContextFactoryName method will cause this JMSAppender instance to use the InitialContext#InitialContext(Hashtable) method instead of the no-argument constructor. If you set this option, you should also at least set the ProviderURL option.

See also #setProviderURL(String) .

 public  void setLocationInfo(boolean locationInfo) 
{
    this.locationInfo = locationInfo;
}

If true, the information sent to the remote subscriber will include caller's location information. By default no location information is sent to the subscriber.

 public  void setPassword(String password) 
{
    this.password = password;
}

The paswword to use when creating a topic session.

 public  void setProviderURL(String providerURL) 
{
    this.providerURL = providerURL;
}

 public  void setSecurityCredentials(String securityCredentials) 
{
    this.securityCredentials = securityCredentials;
}

 public  void setSecurityPrincipalName(String securityPrincipalName) 
{
    this.securityPrincipalName = securityPrincipalName;
}

 public  void setTopicBindingName(String topicBindingName) 
{
    this.topicBindingName = topicBindingName;
}

The TopicBindingName option takes a string value. Its value will be used to lookup the appropriate Topic from the JNDI context.

 public  void setTopicConnectionFactoryBindingName(String tcfBindingName) 
{
    this.tcfBindingName = tcfBindingName;
}

The TopicConnectionFactoryBindingName option takes a string value. Its value will be used to lookup the appropriate TopicConnectionFactory from the JNDI context.

 public  void setURLPkgPrefixes(String urlPkgPrefixes) 
{
    this.urlPkgPrefixes = urlPkgPrefixes;
}

 public  void setUserName(String userName) 
{
    this.userName = userName;
}

The user name to use when String) a topic session . If you set this option, you should also set the Password option. See #setPassword(String) .