AgentManagerRepository.java

/* 
 * 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 org.ngrinder.agent.repository;

import net.grinder.message.console.AgentControllerState;
import org.ngrinder.model.AgentInfo;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
import org.springframework.data.jpa.repository.Modifying;
import org.springframework.data.jpa.repository.Query;
import org.springframework.stereotype.Repository;

/**
 * Agent Repository. This is necessary due to lack of agent info in the Grinder.
 * We need to keep the additional info for each agent in the DB not memory.
 *
 * @author Tobi
 * @author JunHo Yoon
 * @since 3.0
 */
@Repository
public interface AgentManagerRepository extends JpaRepository<AgentInfo, Long>, JpaSpecificationExecutor<AgentInfo> {

	/**
	 * Find a {@link AgentInfo} by ip and host name.
	 *
	 * @param ip       ip
	 * @param hostName host name
	 * @return found agent
	 */
	AgentInfo findByIpAndHostName(String ip, String hostName);

	/**
	 * Find a {@link AgentInfo} by ip.
	 *
	 * @param ip ip of agent
	 * @return found {@link AgentInfo}
	 */
	AgentInfo findByIp(String ip);


	/**
	 * Get the count of {@link AgentInfo} matching the given specification.
	 *
	 * @param spec Query specification
	 * @return agent count
	 */
	long count(Specification<AgentInfo> spec);

	/**
	 * Update system stat.
	 *
	 * @param ip   ip
	 * @param name name
	 * @param s    status string
	 */
	@Modifying
	@Query("update AgentInfo p set p.systemStat=?3 where p.ip=?1 and p.hostName=?2")
	void updateSystemStat(String ip, String name, String s);

	/**
	 * Update agent state.
	 *
	 * @param id    id
	 * @param state state
	 */
	@Modifying
	@Query("update AgentInfo p set p.state=?2 where p.id = ?1")
	void updateState(Long id, AgentControllerState state);
}