001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.ecm.automation.core.annotations;
020
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026import org.nuxeo.ecm.automation.OperationContext;
027import org.nuxeo.ecm.core.api.CoreSession;
028
029/**
030 * To inject contextual data into an operation field. The following context objects are provided:
031 * <ul>
032 * <li>The context itself. See {@link OperationContext}
033 * <li>A Core Session if available. See {@link CoreSession}
034 * <li>A Principal if available. This is the same as {@link CoreSession#getPrincipal()}
035 * <li>Any registered Nuxeo Service.
036 * <ul>
037 * CoreSession or OperationContext into a library instance field.
038 *
039 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
040 */
041@Retention(RetentionPolicy.RUNTIME)
042@Target(ElementType.FIELD)
043public @interface Context {
044
045}