org.xwiki.script.service.ScriptServiceManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-script Show documentation

XWiki Commons - Script

There is a newer version: 16.10.0-rc-1

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.script.service;

import org.xwiki.component.annotation.Role;

/**
 * Provides access to {@link ScriptService} implementation at runtime. Implementations of this interface are supposed to
 * be bound to the Script Context so that they can be access from scripts.
 *
 * @version $Id: 2139e5c7d4d7d6fe0932e2f999c65bc00479937d $
 * @since 2.3M1
 */
@Role
public interface ScriptServiceManager
{
    /**
     * Note that we're voluntarily using an API name of "get" to make it extra easy to access Script Services from
     * Velocity (since in Velocity writing $services.name is equivalent to writing
     * $services.get("name")). It also makes it a short and easy API name for other scripting languages.
     *
     * @param serviceName the name of the service to look for
     * @return the service asked or null if none could be found
     */
    ScriptService get(String serviceName);
}