content: // Licensed to the Apache Software Foundation (ASF) under one
  // or more contributor license agreements.  See the NOTICE file
  // distributed with this work for additional information
  // regarding copyright ownership.  The ASF licenses this file
  // to you 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 org.apache.cloudstack.api.command.admin.router;
  
  import java.util.List;
  
  import org.apache.cloudstack.api.APICommand;
  import org.apache.cloudstack.api.ApiConstants;
  import org.apache.cloudstack.api.ApiErrorCode;
  import org.apache.cloudstack.api.BaseCmd;
  import org.apache.cloudstack.api.Parameter;
  import org.apache.cloudstack.api.ServerApiException;
  import org.apache.cloudstack.api.response.DomainRouterResponse;
  import org.apache.cloudstack.api.response.RouterHealthCheckResultResponse;
  import org.apache.cloudstack.api.response.RouterHealthCheckResultsListResponse;
  import org.apache.cloudstack.context.CallContext;
  import org.apache.commons.lang.BooleanUtils;
  
  import com.cloud.exception.InvalidParameterValueException;
  import com.cloud.exception.ResourceUnavailableException;
  import com.cloud.network.router.VirtualRouter;
  import com.cloud.user.Account;
  import com.cloud.utils.exception.CloudRuntimeException;
  import com.cloud.vm.VirtualMachine;
  
  @APICommand(name = "getRouterHealthCheckResults",
          responseObject = RouterHealthCheckResultsListResponse.class,
          description = "Starts a router.",
          entityType = {VirtualMachine.class},
          requestHasSensitiveInfo = false,
          responseHasSensitiveInfo = false,
          since = "4.14.0")
  public class GetRouterHealthCheckResultsCmd extends BaseCmd {
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.ROUTER_ID, type = CommandType.UUID, entityType = DomainRouterResponse.class,
              required = true, description = "the ID of the router")
      private Long routerId;
  
      @Parameter(name = ApiConstants.PERFORM_FRESH_CHECKS, type = CommandType.BOOLEAN, description = "if true is passed for this parameter, " +
              "health checks are performed on the fly. Else last performed checks data is fetched")
      private Boolean performFreshChecks;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
      public Long getRouterId() {
          return routerId;
      }
  
      public boolean shouldPerformFreshChecks() {
          return BooleanUtils.isTrue(performFreshChecks);
      }
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
  
      @Override
      public long getEntityOwnerId() {
          VirtualRouter router = _entityMgr.findById(VirtualRouter.class, getRouterId());
          if (router != null) {
              return router.getAccountId();
          }
  
          return Account.ACCOUNT_ID_SYSTEM;
      }
  
      @Override
      public void execute() throws ResourceUnavailableException, InvalidParameterValueException, ServerApiException {
          CallContext.current().setEventDetails("Router Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getRouterId()));
          VirtualRouter router = _routerService.findRouter(getRouterId());
          if (router == null || router.getRole() != VirtualRouter.Role.VIRTUAL_ROUTER) {
              throw new InvalidParameterValueException("Can't find router by routerId");
          }
  
          try {
              List<RouterHealthCheckResultResponse> healthChecks = _queryService.listRouterHealthChecks(this);
              RouterHealthCheckResultsListResponse routerResponse = new RouterHealthCheckResultsListResponse();
              routerResponse.setRouterId(router.getUuid());
              routerResponse.setHealthChecks(healthChecks);
              routerResponse.setObjectName("routerhealthchecks");
              routerResponse.setResponseName(getCommandName());
              setResponseObject(routerResponse);
          } catch (CloudRuntimeException ex){
              ex.printStackTrace();
              throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to get health check results due to: " + ex.getLocalizedMessage());
          }
      }
  }
  