Source code

001/*
+002 * Licensed to the Apache Software Foundation (ASF) under one or more
+003 * contributor license agreements. See the NOTICE file distributed with
+004 * this work for additional information regarding copyright ownership.
+005 * The ASF licenses this file to You under the Apache license, Version 2.0
+006 * (the "License"); you may not use this file except in compliance with
+007 * the License. You may obtain a copy of the License at
+008 *
+009 *      http://www.apache.org/licenses/LICENSE-2.0
+010 *
+011 * Unless required by applicable law or agreed to in writing, software
+012 * distributed under the License is distributed on an "AS IS" BASIS,
+013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+014 * See the license for the specific language governing permissions and
+015 * limitations under the license.
+016 */
+017package org.apache.commons.pool2.impl;
+018
+019import java.io.PrintWriter;
+020import java.lang.ref.WeakReference;
+021import java.security.AccessController;
+022import java.security.PrivilegedAction;
+023import java.text.DateFormat;
+024import java.text.SimpleDateFormat;
+025import java.util.ArrayList;
+026import java.util.List;
+027
+028/**
+029 * CallStack strategy using a {@link SecurityManager}. Obtaining the current call stack is much faster via a
+030 * SecurityManger, but access to the underlying method may be restricted by the current SecurityManager. In environments
+031 * where a SecurityManager cannot be created, {@link ThrowableCallStack} should be used instead.
+032 *
+033 * @see RuntimePermission
+034 * @see SecurityManager#getClassContext()
+035 * @since 2.4.3
+036 */
+037public class SecurityManagerCallStack implements CallStack {
+038
+039    private final String messageFormat;
+040    //@GuardedBy("dateFormat")
+041    private final DateFormat dateFormat;
+042    private final PrivateSecurityManager securityManager;
+043
+044    private volatile Snapshot snapshot;
+045
+046    public SecurityManagerCallStack(final String messageFormat, final boolean useTimestamp) {
+047        this.messageFormat = messageFormat;
+048        this.dateFormat = useTimestamp ? new SimpleDateFormat(messageFormat) : null;
+049        this.securityManager = AccessController.doPrivileged(new PrivilegedAction<PrivateSecurityManager>() {
+050            @Override
+051            public PrivateSecurityManager run() {
+052                return new PrivateSecurityManager();
+053            }
+054        });
+055    }
+056
+057    @Override
+058    public boolean printStackTrace(final PrintWriter writer) {
+059        final Snapshot snapshot = this.snapshot;
+060        if (snapshot == null) {
+061            return false;
+062        }
+063        final String message;
+064        if (dateFormat == null) {
+065            message = messageFormat;
+066        } else {
+067            synchronized (dateFormat) {
+068                message = dateFormat.format(snapshot.timestamp);
+069            }
+070        }
+071        writer.println(message);
+072        for (final WeakReference<Class<?>> reference : snapshot.stack) {
+073            writer.println(reference.get());
+074        }
+075        return true;
+076    }
+077
+078    @Override
+079    public void fillInStackTrace() {
+080        snapshot = new Snapshot(securityManager.getCallStack());
+081    }
+082
+083    @Override
+084    public void clear() {
+085        snapshot = null;
+086    }
+087
+088    private static class PrivateSecurityManager extends SecurityManager {
+089        private List<WeakReference<Class<?>>> getCallStack() {
+090            final Class<?>[] classes = getClassContext();
+091            final List<WeakReference<Class<?>>> stack = new ArrayList<WeakReference<Class<?>>>(classes.length);
+092            for (final Class<?> klass : classes) {
+093                stack.add(new WeakReference<Class<?>>(klass));
+094            }
+095            return stack;
+096        }
+097    }
+098
+099    private static class Snapshot {
+100        private final long timestamp = System.currentTimeMillis();
+101        private final List<WeakReference<Class<?>>> stack;
+102
+103        private Snapshot(final List<WeakReference<Class<?>>> stack) {
+104            this.stack = stack;
+105        }
+106    }
+107}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

001/*
+002 * Licensed to the Apache Software Foundation (ASF) under one or more
+003 * contributor license agreements. See the NOTICE file distributed with
+004 * this work for additional information regarding copyright ownership.
+005 * The ASF licenses this file to You under the Apache license, Version 2.0
+006 * (the "License"); you may not use this file except in compliance with
+007 * the License. You may obtain a copy of the License at
+008 *
+009 *      http://www.apache.org/licenses/LICENSE-2.0
+010 *
+011 * Unless required by applicable law or agreed to in writing, software
+012 * distributed under the License is distributed on an "AS IS" BASIS,
+013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+014 * See the license for the specific language governing permissions and
+015 * limitations under the license.
+016 */
+017package org.apache.commons.pool2.impl;
+018
+019import java.io.PrintWriter;
+020import java.text.DateFormat;
+021import java.text.SimpleDateFormat;
+022
+023/**
+024 * CallStack strategy that uses the stack trace from a {@link Throwable}. While being the most portable method of
+025 * obtaining the current call stack, this is also the slowest way to do it. In environments where a new SecurityManager
+026 * can be created, it is preferred to use {@link SecurityManagerCallStack}.
+027 *
+028 * @see Throwable#fillInStackTrace()
+029 * @since 2.4.3
+030 */
+031public class ThrowableCallStack implements CallStack {
+032
+033    private final String messageFormat;
+034    //@GuardedBy("dateFormat")
+035    private final DateFormat dateFormat;
+036
+037    private volatile Snapshot snapshot;
+038
+039    public ThrowableCallStack(final String messageFormat, final boolean useTimestamp) {
+040        this.messageFormat = messageFormat;
+041        this.dateFormat = useTimestamp ? new SimpleDateFormat(messageFormat) : null;
+042    }
+043
+044    @Override
+045    public synchronized boolean printStackTrace(final PrintWriter writer) {
+046        final Snapshot snapshot = this.snapshot;
+047        if (snapshot == null) {
+048            return false;
+049        }
+050        final String message;
+051        if (dateFormat == null) {
+052            message = messageFormat;
+053        } else {
+054            synchronized (dateFormat) {
+055                message = dateFormat.format(snapshot.timestamp);
+056            }
+057        }
+058        writer.println(message);
+059        snapshot.printStackTrace(writer);
+060        return true;
+061    }
+062
+063    @Override
+064    public void fillInStackTrace() {
+065        snapshot = new Snapshot();
+066    }
+067
+068    @Override
+069    public void clear() {
+070        snapshot = null;
+071    }
+072
+073    private static class Snapshot extends Throwable {
+074        private final long timestamp = System.currentTimeMillis();
+075    }
+076}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

Coverage Report - org.apache.commons.pool2.BaseObject

Coverage Report - org.apache.commons.pool2.impl.CallStack

Coverage Report - org.apache.commons.pool2.impl.CallStackUtils

Coverage Report - org.apache.commons.pool2.impl.SecurityManagerCallStack

1		/*
2		* Licensed to the Apache Software Foundation (ASF) under one or more
3		* contributor license agreements. See the NOTICE file distributed with
4		* this work for additional information regarding copyright ownership.
5		* The ASF licenses this file to You under the Apache License, Version 2.0
6		* (the "License"); you may not use this file except in compliance with
7		* the License. You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17		package org.apache.commons.pool2;
18
19		/**
20		* A base class for common functionality.
21		*
22		* @since 2.4.3
23		*/
24	751	public abstract class BaseObject {
25
26		@Override
27		public String toString() {
28	3	final StringBuilder builder = new StringBuilder();
29	3	builder.append(getClass().getSimpleName());
30	3	builder.append(" [");
31	3	toStringAppendFields(builder);
32	3	builder.append("]");
33	3	return builder.toString();
34		}
35
36		/**
37		* Used by sub-classes to include the fields defined by the sub-class in the
38		* {@link #toString()} output.
39		*
40		* @param builder Field names and values are appended to this object
41		*/
42		protected void toStringAppendFields(final StringBuilder builder) {
43		// do nothing by default, needed for b/w compatibility.
44	0	}
45		}