/*
* 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.karaf.scr.command.completer;
import java.util.List;
import org.apache.felix.scr.Component;
import org.apache.felix.scr.ScrService;
import org.apache.karaf.scr.command.action.ScrActionSupport;
import org.apache.karaf.shell.api.action.lifecycle.Reference;
import org.apache.karaf.shell.api.console.CommandLine;
import org.apache.karaf.shell.api.console.Completer;
import org.apache.karaf.shell.api.console.Session;
import org.apache.karaf.shell.support.completers.StringsCompleter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public abstract class ScrCompleterSupport implements Completer {
protected final transient Logger logger = LoggerFactory.getLogger(ScrCompleterSupport.class);
@Reference
private ScrService scrService;
/**
* Overrides the super method noted below. See super documentation for
* details.
*
* @see org.apache.karaf.shell.api.console.Completer#complete(org.apache.karaf.shell.api.console.Session, org.apache.karaf.shell.api.console.CommandLine, java.util.List)
*/
@Override
public int complete(Session session, CommandLine commandLine, List<String> candidates) {
StringsCompleter delegate = new StringsCompleter();
try {
for (Component component : scrService.getComponents()) {
if (logger.isDebugEnabled()) {
logger.debug("Component Name to work on: " + component.getName());
}
if (ScrActionSupport.showHiddenComponent(commandLine, component)) {
// we display all because we are overridden
if (availableComponent(component)) {
delegate.getStrings().add(component.getName());
}
} else {
if (ScrActionSupport.isHiddenComponent(component)) {
// do nothing
} else {
// we aren't hidden so print it
if (availableComponent(component)) {
delegate.getStrings().add(component.getName());
}
}
}
}
} catch (Exception e) {
logger.warn("Exception completing the command request: " + e.getLocalizedMessage());
}
return delegate.complete(session, commandLine, candidates);
}
public abstract boolean availableComponent(Component component) throws Exception;
/**
* Get the scrService Object associated with this instance of
* ScrCompleterSupport.
*
* @return the scrService
*/
public ScrService getScrService() {
return scrService;
}
/**
* Sets the scrService Object for this ScrCompleterSupport instance.
*
* @param scrService the scrService to set
*/
public void setScrService(ScrService scrService) {
this.scrService = scrService;
}
}