/*
* Copyright 2001-2002,2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.webapp.admin.realm;
import java.net.URLEncoder;
import java.util.Iterator;
import java.util.Locale;
import java.io.IOException;
import javax.management.Attribute;
import javax.management.MBeanServer;
import javax.management.MBeanServerFactory;
import javax.management.QueryExp;
import javax.management.Query;
import javax.management.ObjectInstance;
import javax.management.ObjectName;
import javax.management.JMException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import org.apache.struts.action.Action;
import org.apache.struts.action.ActionError;
import org.apache.struts.action.ActionErrors;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.util.MessageResources;
import org.apache.webapp.admin.ApplicationServlet;
import org.apache.webapp.admin.TomcatTreeBuilder;
import org.apache.webapp.admin.TreeControl;
import org.apache.webapp.admin.TreeControlNode;
import org.apache.webapp.admin.valve.ValveUtil;
/**
* The <code>Action</code> that completes <em>Add Realm</em> and
* <em>Edit Realm</em> transactions for JDBC realm.
*
* @author Manveen Kaur
* @version $Revision: 304016 $ $Date: 2005-07-22 09:47:53 -0400 (Fri, 22 Jul 2005) $
*/
public final class SaveJDBCRealmAction extends Action {
// ----------------------------------------------------- Instance Variables
/**
* Signature for the <code>createStandardRealm</code> operation.
*/
private String createStandardRealmTypes[] =
{ "java.lang.String", // parent
"java.lang.String", // driverName
"java.lang.String", // connectionName
"java.lang.String", // connectionPassword
"java.lang.String", // connectionURL
};
/**
* The MBeanServer we will be interacting with.
*/
private MBeanServer mBServer = null;
// --------------------------------------------------------- Public Methods
/**
* Process the specified HTTP request, and create the corresponding HTTP
* response (or forward to another web component that will create it).
* Return an <code>ActionForward</code> instance describing where and how
* control should be forwarded, or <code>null</code> if the response has
* already been completed.
*
* @param mapping The ActionMapping used to select this instance
* @param actionForm The optional ActionForm bean for this request (if any)
* @param request The HTTP request we are processing
* @param response The HTTP response we are creating
*
* @exception IOException if an input/output error occurs
* @exception ServletException if a servlet exception occurs
*/
public ActionForward execute(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws IOException, ServletException {
// Acquire the resources that we need
HttpSession session = request.getSession();
Locale locale = getLocale(request);
MessageResources resources = getResources(request);
// Acquire a reference to the MBeanServer containing our MBeans
try {
mBServer = ((ApplicationServlet) getServlet()).getServer();
} catch (Throwable t) {
throw new ServletException
("Cannot acquire MBeanServer reference", t);
}
// Identify the requested action
JDBCRealmForm rform = (JDBCRealmForm) form;
String adminAction = rform.getAdminAction();
String rObjectName = rform.getObjectName();
// Perform a "Create JDBC Realm" transaction (if requested)
if ("Create".equals(adminAction)) {
String operation = null;
String values[] = null;
try {
String parent = rform.getParentObjectName();
String objectName = ValveUtil.getObjectName(parent,
TomcatTreeBuilder.REALM_TYPE);
ObjectName pname = new ObjectName(parent);
StringBuffer sb = new StringBuffer(pname.getDomain());
// For service, create the corresponding Engine mBean
// Parent in this case needs to be the container mBean for the service
try {
if ("Service".equalsIgnoreCase(pname.getKeyProperty("type"))) {
sb.append(":type=Engine");
parent = sb.toString();
}
} catch (Exception e) {
String message =
resources.getMessage(locale, "error.engineName.bad",
sb.toString());
getServlet().log(message);
response.sendError(HttpServletResponse.SC_BAD_REQUEST, message);
return (null);
}
// Ensure that the requested user database name is unique
ObjectName oname =
new ObjectName(objectName);
if (mBServer.isRegistered(oname)) {
ActionErrors errors = new ActionErrors();
errors.add("realmName",
new ActionError("error.realmName.exists"));
saveErrors(request, errors);
return (new ActionForward(mapping.getInput()));
}
String domain = oname.getDomain();
// Look up our MBeanFactory MBean
ObjectName fname =
TomcatTreeBuilder.getMBeanFactory();
// Create a new StandardRealm object
values = new String[5];
values[0] = parent;
values[1] = rform.getDriver();
values[2] = rform.getConnectionName();
values[3] = rform.getConnectionPassword();
values[4] = rform.getConnectionURL();
operation = "createJDBCRealm";
rObjectName = (String)
mBServer.invoke(fname, operation,
values, createStandardRealmTypes);
if (rObjectName==null) {
request.setAttribute("warning", "error.jdbcrealm");
return (mapping.findForward("Save Unsuccessful"));
}
// Add the new Realm to our tree control node
TreeControl control = (TreeControl)
session.getAttribute("treeControlTest");
if (control != null) {
TreeControlNode parentNode = control.findNode(rform.getParentObjectName());
if (parentNode != null) {
String nodeLabel = rform.getNodeLabel();
String encodedName =
URLEncoder.encode(rObjectName,TomcatTreeBuilder.URL_ENCODING);
TreeControlNode childNode =
new TreeControlNode(rObjectName,
"Realm.gif",
nodeLabel,
"EditRealm.do?select=" +
encodedName,
"content",
true, domain);
parentNode.addChild(childNode);
// FIXME - force a redisplay
} else {
getServlet().log
("Cannot find parent node '" + parent + "'");
}
} else {
getServlet().log
("Cannot find TreeControlNode!");
}
} catch (Exception e) {
getServlet().log
(resources.getMessage(locale, "users.error.invoke",
operation), e);
response.sendError
(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
resources.getMessage(locale, "users.error.invoke",
operation));
return (null);
}
}
// Perform attribute updates as requested
String attribute = null;
String value = null;
try {
ObjectName roname = new ObjectName(rObjectName);
attribute = "digest";
value = rform.getDigest();
setAttributeIfPresent(mBServer, roname, attribute, value);
attribute = "driverName";
value = rform.getDriver();
setAttributeIfPresent(mBServer, roname, attribute, value);
attribute = "roleNameCol";
value = rform.getRoleNameCol();
setAttributeIfPresent(mBServer, roname, attribute, value);
attribute = "userNameCol";
value = rform.getUserNameCol();
setAttributeIfPresent(mBServer, roname, attribute, value);
attribute = "userCredCol";
value = rform.getPasswordCol();
setAttributeIfPresent(mBServer, roname, attribute, value);
attribute = "userTable";
value = rform.getUserTable();
setAttributeIfPresent(mBServer, roname, attribute, value);
attribute = "userRoleTable";
value = rform.getRoleTable();
setAttributeIfPresent(mBServer, roname, attribute, value);
attribute = "connectionName";
value = rform.getConnectionName();
setAttributeIfPresent(mBServer, roname, attribute, value);
attribute = "connectionURL";
value = rform.getConnectionURL();
setAttributeIfPresent(mBServer, roname, attribute, value);
attribute = "connectionPassword";
value = rform.getConnectionPassword();
setAttributeIfPresent(mBServer, roname, attribute, value);
} catch (Exception e) {
getServlet().log
(resources.getMessage(locale, "users.error.attribute.set",
attribute), e);
response.sendError
(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
resources.getMessage(locale, "users.error.attribute.set",
attribute));
return (null);
}
// Forward to the success reporting page
session.removeAttribute(mapping.getAttribute());
return (mapping.findForward("Save Successful"));
}
/**
* Sets the given attribute to the given value
* in the given server's object name, if the value
* is not null or empty.
*
* @param theServer The server
* @param roname The object name
* @param attribute The attribute name
* @param value The attribute value
* @throws JMException If a JMX error occurs
*/
protected void setAttributeIfPresent(MBeanServer mBServer, ObjectName roname, String attribute, String value)
throws JMException {
if((mBServer == null) || (roname == null) || (attribute == null)) {
throw new IllegalArgumentException("MBeanServer, ObjectName, attribute required.");
}
if((value != null) && (value.trim().length() > 0)) {
mBServer.setAttribute(roname,
new Attribute(attribute, value));
}
}
}