com.marklogic.xcc.jndi.ContentSourceBeanFactory Maven / Gradle / Ivy
Show all versions of marklogic-xcc Show documentation
/*
* Copyright (c) 2020 MarkLogic Corporation
*
* 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 com.marklogic.xcc.jndi;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Enumeration;
import java.util.Hashtable;
import javax.naming.Context;
import javax.naming.Name;
import javax.naming.NamingException;
import javax.naming.RefAddr;
import javax.naming.Reference;
import javax.naming.spi.ObjectFactory;
import com.marklogic.xcc.ContentSource;
import com.marklogic.xcc.ContentSourceFactory;
/**
*
* This class implements the JNDI {@link ObjectFactory} interface and may be used in a J2EE
* container as a source of {@link com.marklogic.xcc.ContentSource} instances. This class is
* preferred over {@link ContentSourceBean} if you have the option because it does a little more
* consistency checking when creating new objects. Neither does it depend on a container-provided
* bean factory.
*
*
* JNDI resources are typically specified as part of the container configuration. The specifics of
* configuration vary by container. Below is an example of using this class with Apache Tomcat version 5.5 to configure a
* {@link com.marklogic.xcc.ContentSource}. Further details of JNDI configuration in Tomcat are
* available on the JNDI-HowTo page.
*
*
* There are two places where JNDI resources can be configured in the Tomcat 5.5 container. One is
* globally in Tomcat's config file in $CATALINA_HOME/conf/server.xml, the other is within an
* individual webapp in META-INF/context.xml. In either file, an XML element like this should be
* placed as a child of the <Context> element, like this:
*
*
*
* <Context path="/">
* <Resource name="marklogic/ContentSource" auth="Container"
* type="com.marklogic.xcc.ContentSource"
* factory="com.marklogic.xcc.jndi.ContentSourceBeanFactory"
* host="somehost.mycorp.com" port="8003" user="fred" password="hush"
* contentbase="productiondb"/>
* <Context>
*
*
* An alternate means of specifying the content source is via the "url" attribute, like this:
*
*
*
* <Context path="/">
* <Resource name="marklogic/ContentSource" auth="Container"
* type="com.marklogic.xcc.ContentSource"
* factory="com.marklogic.xcc.jndi.ContentSourceBeanFactory"
* url="xcc://fred:[email protected]:8003/productiondb"/>
* <Context>
*
*
* The value of the "name" attribute is the JNDI lookup key that you will use in your code (servlet,
* JSP scriptlet, etc) to locate the {@link com.marklogic.xcc.ContentSource}. A typical method to do
* the lookup would look something like this:
*
*
*
* private ContentSource findContentSource() throws ServletException {
* try {
* Context initCtx = new InitialContext();
* Context envCtx = (Context)initCtx.lookup("java:comp/env");
*
* return (ContentSource)envCtx.lookup("marklogic/ContentSource");
* } catch (NamingException e) {
* throw new ServletException("ContentSource lookup failed: " + e, e);
* }
* }
*
*/
@SuppressWarnings("deprecation")
public class ContentSourceBeanFactory implements ObjectFactory {
public Object getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable environment) throws Exception {
String host = null;
int port = 0;
String user = null;
String password = null;
String contentBase = null;
URI url = null;
boolean authenticationPreemptive = false;
if (obj instanceof Reference) {
Reference ref = (Reference) obj;
Enumeration addrs = ref.getAll();
while (addrs.hasMoreElements()) {
RefAddr addr = addrs.nextElement();
String attrName = addr.getType();
String attrValue = (String) addr.getContent();
host = attrName.equals("host") ? attrValue : host;
user = attrName.equals("user") ? attrValue : user;
password = attrName.equals("password") ? attrValue : password;
authenticationPreemptive = attrName.equals("authenticationPreemptive") ?
"true".equals(attrValue) : authenticationPreemptive;
contentBase = attrName.equals("contentBase") ? attrValue : contentBase;
try {
url = attrName.equals("url") ? new URI(attrValue) : url;
} catch (URISyntaxException e) {
throw new NamingException("Bad URL: " + attrValue);
}
try {
port = attrName.equals("port") ? Integer.parseInt(attrValue) : port;
} catch (NumberFormatException e) {
throw new NamingException("Invalid port value " + attrValue);
}
}
} else if (environment!=null && environment.size()>0) {
host = environment.containsKey("host") ? (String) environment.get("host") : host;
user = environment.containsKey("user") ? (String) environment.get("user") : user;
password = environment.containsKey("password") ? (String) environment.get("password") : password;
authenticationPreemptive = environment.containsKey("authenticationPreemptive") ?
"true".equals(environment.get("authenticationPreemptive")) : authenticationPreemptive;
contentBase = environment.containsKey("contentBase") ? (String) environment.get("contentBase") : contentBase;
try {
url = environment.containsKey("url") ? new URI((String) environment.get("url")) : url;
} catch (URISyntaxException e) {
throw new NamingException("Bad URL: " + environment.get("url") );
}
try {
port = environment.containsKey("port") ? Integer.parseInt((String) environment.get("port")) : port;
} catch (NumberFormatException e) {
throw new NamingException("Invalid port value" + environment.get("port"));
}
}
if ((url == null) && ((host == null) || (port == 0))) {
throw new NamingException("At least URL or host and port attributes must be specified");
}
ContentSource contentSource;
if (url != null) {
contentSource = ContentSourceFactory.newContentSource(url);
} else {
contentSource = ContentSourceFactory.newContentSource(host, port, user, password, contentBase);
}
contentSource.setAuthenticationPreemptive(authenticationPreemptive);
return contentSource;
}
}