Package org.apache.camel.component.github

Class GitHubEndpoint

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultEndpoint
org.apache.camel.support.ScheduledPollEndpoint
org.apache.camel.component.github.GitHubEndpoint
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.EndpointServiceLocation, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@UriEndpoint(firstVersion="2.15.0", scheme="github", title="GitHub", syntax="github:type/branchName", category={FILE,CLOUD,API}, headersClass=GitHubConstants.class) public class GitHubEndpoint extends org.apache.camel.support.ScheduledPollEndpoint implements org.apache.camel.spi.EndpointServiceLocation
Interact with the GitHub API. The endpoint encapsulates portions of the GitHub API, relying on the org.eclipse.egit.github.core Java SDK. Available endpoint URIs include: CONSUMERS github://pullRequest (new pull requests) github://pullRequestComment (new pull request comments) github://commit/[branch] (new commits) github://tag (new tags) PRODUCERS github://pullRequestComment (create a new pull request comment; see PullRequestCommentProducer for header requirements) The endpoints will respond with org.eclipse.egit.github.core-provided POJOs (PullRequest, CommitComment, RepositoryTag, RepositoryCommit, etc.) Note: Rather than webhooks, this endpoint relies on simple polling. Reasons include: - concerned about reliability/stability if this somehow relied on an exposed, embedded server (Jetty?) - the types of payloads we're polling aren't typically large (plus, paging is available in the API) - need to support apps running somewhere not publicly accessible where a webhook would fail

  • Field Summary

    Fields inherited from class org.apache.camel.support.service.BaseService

    BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

  • Constructor Summary

    Constructors
    Constructor
    Description
    GitHubEndpoint(String uri, GitHubComponent component)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.camel.Consumer
    createConsumer(org.apache.camel.Processor processor)
     
    org.apache.camel.Producer
    createProducer()
     
    protected void
    doInit()
     
    String
    getBranchName()
     
    String
    getEncoding()
     
    GitHubEventFetchStrategy
    getEventFetchStrategy()
     
    String
    getOauthToken()
     
    String
    getRepoName()
     
    String
    getRepoOwner()
     
    String
    getServiceProtocol()
     
    String
    getServiceUrl()
     
    String
    getStartingSha()
     
    String
    getState()
     
    String
    getTargetUrl()
     
    GitHubType
    getType()
     
    void
    setBranchName(String branchName)
    Name of branch
    void
    setEncoding(String encoding)
    To use the given encoding when getting a git commit file
    void
    setEventFetchStrategy(GitHubEventFetchStrategy eventFetchStrategy)
    To specify a custom strategy that configures how the EventsConsumer fetches events.
    void
    setOauthToken(String oauthToken)
    GitHub OAuth token.
    void
    setRepoName(String repoName)
    GitHub repository name
    void
    setRepoOwner(String repoOwner)
    GitHub repository owner (organization)
    void
    setStartingSha(String startingSha)
    The starting sha to use for polling commits with the commit consumer.
    void
    setState(String state)
    To set git commit status state
    void
    setTargetUrl(String targetUrl)
    To set git commit status target url
    void
    setType(GitHubType type)
    What git operation to execute

    Methods inherited from class org.apache.camel.support.ScheduledPollEndpoint

    configureConsumer, configureProperties, configureScheduledPollConsumerProperties, doConfigureConsumer, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDefaultDelay, getDelay, getInitialDelay, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRepeatCount, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

    Methods inherited from class org.apache.camel.support.DefaultEndpoint

    configureExchange, configurePollingConsumer, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

    Methods inherited from class org.apache.camel.support.service.BaseService

    build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.apache.camel.ComponentAware

    getComponent

    Methods inherited from interface org.apache.camel.Endpoint

    getEndpointBaseUri, isRemote, isSingletonProducer

    Methods inherited from interface org.apache.camel.spi.EndpointServiceLocation

    getServiceMetadata

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    Methods inherited from interface org.apache.camel.StatefulService

    getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

    Methods inherited from interface org.apache.camel.SuspendableService

    isSuspended, resume, suspend

  • Constructor Details

  • Method Details

    • getServiceUrl

      public String getServiceUrl()
      Specified by:
      getServiceUrl in interface org.apache.camel.spi.EndpointServiceLocation

    • getServiceProtocol

      public String getServiceProtocol()
      Specified by:
      getServiceProtocol in interface org.apache.camel.spi.EndpointServiceLocation

    • createProducer

      public org.apache.camel.Producer createProducer() throws Exception
      Specified by:
      createProducer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • createConsumer

      public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor) throws Exception
      Specified by:
      createConsumer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • getType

      public GitHubType getType()

    • setType

      public void setType(GitHubType type)
      What git operation to execute

    • getBranchName

      public String getBranchName()

    • setBranchName

      public void setBranchName(String branchName)
      Name of branch

    • getStartingSha

      public String getStartingSha()

    • setStartingSha

      public void setStartingSha(String startingSha)
      The starting sha to use for polling commits with the commit consumer. The value can either be a sha for the sha to start from, or use beginning to start from the beginning, or last to start from the last commit.

    • getOauthToken

      public String getOauthToken()

    • setOauthToken

      public void setOauthToken(String oauthToken)
      GitHub OAuth token. Must be configured on either component or endpoint.

    • getRepoOwner

      public String getRepoOwner()

    • setRepoOwner

      public void setRepoOwner(String repoOwner)
      GitHub repository owner (organization)

    • getRepoName

      public String getRepoName()

    • setRepoName

      public void setRepoName(String repoName)
      GitHub repository name

    • getState

      public String getState()

    • setState

      public void setState(String state)
      To set git commit status state

    • getTargetUrl

      public String getTargetUrl()

    • setTargetUrl

      public void setTargetUrl(String targetUrl)
      To set git commit status target url

    • getEncoding

      public String getEncoding()

    • setEncoding

      public void setEncoding(String encoding)
      To use the given encoding when getting a git commit file

    • getEventFetchStrategy

      public GitHubEventFetchStrategy getEventFetchStrategy()

    • setEventFetchStrategy

      public void setEventFetchStrategy(GitHubEventFetchStrategy eventFetchStrategy)
      To specify a custom strategy that configures how the EventsConsumer fetches events.

    • doInit

      protected void doInit() throws Exception
      Overrides:
      doInit in class org.apache.camel.support.DefaultEndpoint
      Throws:
      Exception