StatusPlexusResource.java

/**
 * Copyright (c) 2008-2011 Sonatype, Inc.
 * All rights reserved. Includes the third-party code listed at http://www.sonatype.com/products/nexus/attributions.
 *
 * This program is free software: you can redistribute it and/or modify it only under the terms of the GNU Affero General
 * Public License Version 3 as published by the Free Software Foundation.
 *
 * This program 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 Affero General Public License Version 3
 * for more details.
 *
 * You should have received a copy of the GNU Affero General Public License Version 3 along with this program.  If not, see
 * http://www.gnu.org/licenses.
 *
 * Sonatype Nexus (TM) Open Source Version is available from Sonatype, Inc. Sonatype and Sonatype Nexus are trademarks of
 * Sonatype, Inc. Apache Maven is a trademark of the Apache Foundation. M2Eclipse is a trademark of the Eclipse Foundation.
 * All other trademarks are the property of their respective owners.
 */
package org.sonatype.nexus.rest.status;

import java.io.PrintWriter;
import java.io.StringWriter;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;

import org.codehaus.enunciate.contract.jaxrs.ResourceMethodSignature;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;
import org.restlet.Context;
import org.restlet.data.Request;
import org.restlet.data.Response;
import org.restlet.resource.ResourceException;
import org.restlet.resource.Variant;
import org.sonatype.nexus.Nexus;
import org.sonatype.nexus.SystemStatus;
import org.sonatype.nexus.rest.model.NexusAuthenticationClientPermissions;
import org.sonatype.nexus.rest.model.StatusResource;
import org.sonatype.nexus.rest.model.StatusResourceResponse;
import org.sonatype.plexus.rest.resource.ManagedPlexusResource;
import org.sonatype.plexus.rest.resource.PathProtectionDescriptor;
import org.sonatype.security.rest.authentication.AbstractUIPermissionCalculatingPlexusResource;
import org.sonatype.security.rest.model.AuthenticationClientPermissions;

@Component( role = ManagedPlexusResource.class, hint = "StatusPlexusResource" )
@Path( StatusPlexusResource.RESOURCE_URI )
@Produces( { "application/xml", "application/json" } )
public class StatusPlexusResource
    extends AbstractUIPermissionCalculatingPlexusResource
    implements ManagedPlexusResource
{
    public static final String RESOURCE_URI = "/status"; 

    @Requirement
    private Nexus nexus;
    
    @Override
    public Object getPayloadInstance()
    {
        return null;
    }

    @Override
    public String getResourceUri()
    {
        return RESOURCE_URI;
    }

    @Override
    public PathProtectionDescriptor getResourceProtection()
    {
        return new PathProtectionDescriptor( getResourceUri(), "authcNxBasic,perms[nexus:status]" );
    }

    /**
     * Get the status of the nexus server.
     */
    @Override
    @GET
    @ResourceMethodSignature( output = StatusResourceResponse.class )
    public Object get( Context context, Request request, Response response, Variant variant )
        throws ResourceException
    {
        SystemStatus status = this.nexus.getSystemStatus();

        StatusResource resource = new StatusResource();

        resource.setAppName( status.getAppName() );

        resource.setFormattedAppName( status.getFormattedAppName() );

        resource.setVersion( status.getVersion() );

        resource.setApiVersion( status.getApiVersion() );

        resource.setEditionLong( status.getEditionLong() );

        resource.setEditionShort( status.getEditionShort() );

        resource.setState( status.getState().toString() );

        resource.setOperationMode( status.getOperationMode().toString() );

        resource.setInitializedAt( status.getInitializedAt() );

        resource.setStartedAt( status.getStartedAt() );

        resource.setLastConfigChange( status.getLastConfigChange() );

        resource.setFirstStart( status.isFirstStart() );

        resource.setInstanceUpgraded( status.isInstanceUpgraded() );

        resource.setConfigurationUpgraded( status.isConfigurationUpgraded() );

        resource.setErrorCause( spit( status.getErrorCause() ) );

        // if ( status.getConfigurationValidationResponse() != null )
        // {
        // resource.setConfigurationValidationResponse( new StatusConfigurationValidationResponse() );
        //
        // resource.getConfigurationValidationResponse().setValid(
        // status.getConfigurationValidationResponse().isValid() );
        //
        // resource.getConfigurationValidationResponse().setModified(
        // status.getConfigurationValidationResponse().isModified() );
        //
        // for ( ValidationMessage msg : status.getConfigurationValidationResponse().getValidationErrors() )
        // {
        // resource.getConfigurationValidationResponse().addValidationError( msg.toString() );
        // }
        // for ( ValidationMessage msg : status.getConfigurationValidationResponse().getValidationWarnings() )
        // {
        // resource.getConfigurationValidationResponse().addValidationWarning( msg.toString() );
        // }
        // }

        resource.setClientPermissions( this.getClientPermissions( request ) );

        resource.setBaseUrl( getContextRoot( request ).toString() );

        StatusResourceResponse result = new StatusResourceResponse();

        result.setData( resource );

        return result;
    }

    private NexusAuthenticationClientPermissions getClientPermissions(Request request) throws ResourceException
    {
        AuthenticationClientPermissions originalClientPermissions = getClientPermissionsForCurrentUser( request );
        
        // TODO: this is a modello work around,
        // the SystemStatus could not include a field of type AuthenticationClientPermissions
        // because it is in a different model, but I can extend that class... and include it.
        
        NexusAuthenticationClientPermissions clientPermissions = new NexusAuthenticationClientPermissions();
        clientPermissions.setLoggedIn( originalClientPermissions.isLoggedIn() );
        clientPermissions.setLoggedInUsername( originalClientPermissions.getLoggedInUsername() );
        clientPermissions.setLoggedInUserSource( originalClientPermissions.getLoggedInUserSource() );
        clientPermissions.setLoggedInUserSource( originalClientPermissions.getLoggedInUserSource() );
        clientPermissions.setPermissions( originalClientPermissions.getPermissions() );
        
        return clientPermissions;
    }

    private String spit( Throwable t )
    {
        if ( t == null )
        {
            return null;
        }
        else
        {
            StringWriter sw = new StringWriter();

            t.printStackTrace( new PrintWriter( sw ) );

            return sw.toString();
        }

    }
}