/*
 * Copyright (c) 2022 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.client.extensions;

import com.marklogic.client.util.RequestLogger;
import com.marklogic.client.impl.ResourceManagerImplementation;

/**
 * ResourceManager is the base class for a client interface
 * to resource services.  Resource Service extensions can be
 * installed on the server using {@link com.marklogic.client.admin.ResourceExtensionsManager}.
 * Initialize a ResourceManager object by passing it to the
 * {@link com.marklogic.client.DatabaseClient}.init() method. 
 *
 * <p>To expose the services provided by a resource service extension to
 * applications, implement a subclass of ResourceManager. In your subclass, use
 * the methods of a {@link ResourceServices} object to call the Resource Services
 * on the server.</p>
 *
 * <p>Obtain a {@link ResourceServices} object by calling the protected
 * <code>getServices</code> method of the ResourceManager. This method
 * has the following signature:</p>
 *
 * <p><code>{@link ResourceServices} getServices()</code></p>
 */
abstract public class ResourceManager
  extends ResourceManagerImplementation
{
  protected ResourceManager() {
    super();
  }
  /**
   * Returns the name of the resource.
   * @return	the name of the resource
   */
  public String getName() {
    ResourceServices services = getServices();
    return (services != null) ? services.getResourceName() : null;
  }

  /**
   * Starts debugging client requests. You can suspend and resume debugging output
   * using the methods of the logger.
   *
   * @param logger	the logger that receives debugging output
   */
  public void startLogging(RequestLogger logger) {
    ResourceServices services = getServices();
    if (services != null)
      services.startLogging(logger);
  }
  /**
   *  Stops debugging client requests.
   */
  public void stopLogging() {
    ResourceServices services = getServices();
    if (services != null)
      services.stopLogging();
  }
}
