com.peterphi.std.guice.web.rest.scoping.SessionScoping Maven / Gradle / Ivy

Go to download
package com.peterphi.std.guice.web.rest.scoping;

/**
 * Based on Guice ServletScopes

 *
 * Copyright (C) 2006 Google Inc.
 *
 * 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.
 */


import com.google.inject.Key;
import com.google.inject.Provider;
import com.google.inject.Scope;
import com.google.inject.Scopes;
import com.peterphi.std.guice.web.HttpCallContext;

import javax.servlet.http.HttpSession;

final class SessionScoping implements Scope
{
	public static final SessionScoping INSTANCE = new SessionScoping();

	/**
	 * A sentinel attribute value representing null.
	 */
	enum NullObject
	{
		INSTANCE
	}

	private SessionScoping()
	{
	}

	public  Provider scope(Key key, final Provider creator)
	{
		final String name = key.toString();

		return new Provider()
		{
			public T get()
			{
				final HttpCallContext ctx = HttpCallContext.get();
				final HttpSession session = ctx.getRequest().getSession();

				synchronized (session)
				{
					final Object obj = session.getAttribute(name);
					if (NullObject.INSTANCE == obj)
					{
						return null;
					}
					else
					{
						@SuppressWarnings("unchecked") T t = (T) obj;

						if (t == null)
						{
							// Construct a new instance
							t = creator.get();

							// Cache the instance (unless it's a circular proxy)
							if (!Scopes.isCircularProxy(t))
							{
								if (t == null)
									session.setAttribute(name, NullObject.INSTANCE);
								else
									session.setAttribute(name, t);
							}
						}

						return t;
					}
				}
			}

			@Override
			public String toString()
			{
				return String.format("%s[%s]", creator, SessionScoping.INSTANCE);
			}
		};
	}

	@Override
	public String toString()
	{
		return "SessionScoping";
	}
}