Package org.apache.camel.component.github2

Class GitHub2Endpoint

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.github2.GitHub2Endpoint
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="4.18.0", scheme="github2", title="GitHub2", syntax="github2:type/branchName", category={FILE,CLOUD,API}, headersClass=GitHub2Constants.class) public class GitHub2Endpoint extends org.apache.camel.support.ScheduledPollEndpoint implements org.apache.camel.spi.EndpointServiceLocation
Interact with the GitHub API. This component uses the kohsuke github-api library for GitHub API interactions. Available endpoint URIs include: CONSUMERS github2://pullRequest (new pull requests) github2://pullRequestComment (new pull request comments) github2://commit/[branch] (new commits) github2://tag (new tags) github2://event (GitHub events) PRODUCERS github2://pullRequestComment (create a new pull request comment) github2://closePullRequest (close a pull request) github2://pullRequestState (set commit status) github2://pullRequestFiles (get PR files) github2://getCommitFile (get commit file content) github2://createIssue (create an issue) The endpoints respond with org.kohsuke.github POJOs (GHPullRequest, GHCommit, GHIssue, etc.)

  • 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
    GitHub2Endpoint(String uri, GitHub2Component 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
    getApiUrl()
     
    String
    getBranchName()
     
    String
    getEncoding()
     
    GitHub2EventFetchStrategy
    getEventFetchStrategy()
     
    String
    getOauthToken()
     
    String
    getRepoName()
     
    String
    getRepoOwner()
     
    String
    getServiceProtocol()
     
    String
    getServiceUrl()
     
    String
    getStartingSha()
     
    String
    getState()
     
    String
    getTargetUrl()
     
    GitHub2Type
    getType()
     
    boolean
    isCommitMessageAsBody()
     
    void
    setApiUrl(String apiUrl)
    GitHub API URL for GitHub Enterprise.
    void
    setBranchName(String branchName)
    Name of branch
    void
    setCommitMessageAsBody(boolean commitMessageAsBody)
    Whether the commit consumer should store the commit message or the raw org.kohsuke.github.GHCommit object as the message body.
    void
    setEncoding(String encoding)
    To use the given encoding when getting a git commit file
    void
    setEventFetchStrategy(GitHub2EventFetchStrategy 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(GitHub2Type 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 GitHub2Type getType()

    • setType

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

    • getBranchName

      public String getBranchName()

    • setBranchName

      public void setBranchName(String branchName)
      Name of branch

    • isCommitMessageAsBody

      public boolean isCommitMessageAsBody()

    • setCommitMessageAsBody

      public void setCommitMessageAsBody(boolean commitMessageAsBody)
      Whether the commit consumer should store the commit message or the raw org.kohsuke.github.GHCommit object as the message body.

    • 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 GitHub2EventFetchStrategy getEventFetchStrategy()

    • setEventFetchStrategy

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

    • getApiUrl

      public String getApiUrl()

    • setApiUrl

      public void setApiUrl(String apiUrl)
      GitHub API URL for GitHub Enterprise. Leave empty for github.com.

    • doInit

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